From 36d22d82aa202bb199967e9512281e9a53db42c9 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Sun, 7 Apr 2024 21:33:14 +0200 Subject: Adding upstream version 115.7.0esr. Signed-off-by: Daniel Baumann --- dom/base/TimeoutHandler.h | 104 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 104 insertions(+) create mode 100644 dom/base/TimeoutHandler.h (limited to 'dom/base/TimeoutHandler.h') diff --git a/dom/base/TimeoutHandler.h b/dom/base/TimeoutHandler.h new file mode 100644 index 0000000000..ce659d7623 --- /dev/null +++ b/dom/base/TimeoutHandler.h @@ -0,0 +1,104 @@ +/* -*- 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_timeout_handler_h +#define mozilla_dom_timeout_handler_h + +#include "nsCOMPtr.h" +#include "nsIGlobalObject.h" +#include "nsISupports.h" +#include "nsCycleCollectionParticipant.h" +#include "nsString.h" +#include "mozilla/Attributes.h" +#include "mozilla/dom/FunctionBinding.h" + +namespace mozilla::dom { + +/** + * Utility class for implementing nsITimeoutHandlers, designed to be subclassed. + */ +class TimeoutHandler : public nsISupports { + public: + MOZ_CAN_RUN_SCRIPT virtual bool Call(const char* /* unused */); + // Get the location of the script. + // Note: The memory pointed to by aFileName is owned by the + // nsITimeoutHandler and should not be freed by the caller. + virtual void GetLocation(const char** aFileName, uint32_t* aLineNo, + uint32_t* aColumn); + // Append a UTF-8 string to aOutString that describes the callback function, + // for use in logging or profiler markers. + // The string contains the function name and its source location, if + // available, in the following format: + // " (::)" + virtual void GetDescription(nsACString& aOutString); + virtual void MarkForCC() {} + + protected: + TimeoutHandler() : mFileName(""), mLineNo(0), mColumn(0) {} + explicit TimeoutHandler(JSContext* aCx); + + virtual ~TimeoutHandler() = default; + + // filename, line number and JS language version string of the + // caller of setTimeout() + nsCString mFileName; + uint32_t mLineNo; + uint32_t mColumn; + + private: + TimeoutHandler(const TimeoutHandler&) = delete; + TimeoutHandler& operator=(const TimeoutHandler&) = delete; + TimeoutHandler& operator=(const TimeoutHandler&&) = delete; +}; + +class ScriptTimeoutHandler : public TimeoutHandler { + public: + NS_DECL_CYCLE_COLLECTING_ISUPPORTS + NS_DECL_CYCLE_COLLECTION_CLASS(ScriptTimeoutHandler) + + ScriptTimeoutHandler(JSContext* aCx, nsIGlobalObject* aGlobal, + const nsAString& aExpression); + + MOZ_CAN_RUN_SCRIPT virtual bool Call(const char* /* unused */) override { + return false; + }; + virtual void GetDescription(nsACString& aOutString) override; + + protected: + virtual ~ScriptTimeoutHandler() = default; + + nsCOMPtr mGlobal; + // The expression to evaluate or function to call. If mFunction is non-null + // it should be used, else use mExpr. + nsString mExpr; +}; + +class CallbackTimeoutHandler final : public TimeoutHandler { + public: + NS_DECL_CYCLE_COLLECTING_ISUPPORTS + NS_DECL_CYCLE_COLLECTION_SCRIPT_HOLDER_CLASS(CallbackTimeoutHandler) + + CallbackTimeoutHandler(JSContext* aCx, nsIGlobalObject* aGlobal, + Function* aFunction, + nsTArray>&& aArguments); + + MOZ_CAN_RUN_SCRIPT virtual bool Call(const char* aExecutionReason) override; + virtual void MarkForCC() override; + virtual void GetDescription(nsACString& aOutString) override; + + void ReleaseJSObjects(); + + private: + virtual ~CallbackTimeoutHandler() { ReleaseJSObjects(); } + + nsCOMPtr mGlobal; + RefPtr mFunction; + nsTArray> mArgs; +}; + +} // namespace mozilla::dom + +#endif // mozilla_dom_timeout_handler_h -- cgit v1.2.3