mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-10-19 08:15:31 +00:00
dda8b08621
We should have the same public API available whenever possible, and make it a no-op or make it throw immediately if JS was built without support for it, instead of showing or hiding the API in header files using configure macros. Otherwise embedders can easily get mismatches between a library with functionality and header files without it, or vice versa. There was no good reason why JS_GetErrorType() was nightly-only API, so this also enables it unconditionally. Differential Revision: https://phabricator.services.mozilla.com/D52124 --HG-- extra : moz-landing-system : lando
152 lines
6.0 KiB
C++
152 lines
6.0 KiB
C++
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
|
/* 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/. */
|
|
|
|
/*
|
|
* Types and functions related to the compilation of JavaScript off the
|
|
* direct JSAPI-using thread.
|
|
*/
|
|
|
|
#ifndef js_OffThreadScriptCompilation_h
|
|
#define js_OffThreadScriptCompilation_h
|
|
|
|
#include "mozilla/Range.h" // mozilla::Range
|
|
#include "mozilla/Utf8.h" // mozilla::Utf8Unit
|
|
#include "mozilla/Vector.h" // mozilla::Vector
|
|
|
|
#include <stddef.h> // size_t
|
|
|
|
#include "jstypes.h" // JS_PUBLIC_API
|
|
|
|
#include "js/BinASTFormat.h" // JS::BinASTFormat
|
|
#include "js/CompileOptions.h" // JS::ReadOnlyCompileOptions
|
|
#include "js/GCVector.h" // JS::GCVector
|
|
#include "js/Transcoding.h" // JS::TranscodeSource
|
|
|
|
struct JS_PUBLIC_API JSContext;
|
|
class JS_PUBLIC_API JSScript;
|
|
|
|
namespace JS {
|
|
|
|
template <typename UnitT>
|
|
class SourceText;
|
|
|
|
} // namespace JS
|
|
|
|
namespace JS {
|
|
|
|
class OffThreadToken;
|
|
|
|
using OffThreadCompileCallback = void (*)(OffThreadToken* token,
|
|
void* callbackData);
|
|
|
|
/*
|
|
* Off thread compilation control flow.
|
|
*
|
|
* After successfully triggering an off thread compile of a script, the
|
|
* callback will eventually be invoked with the specified data and a token
|
|
* for the compilation. The callback will be invoked while off thread,
|
|
* so must ensure that its operations are thread safe. Afterwards, one of the
|
|
* following functions must be invoked on the runtime's main thread:
|
|
*
|
|
* - FinishOffThreadScript, to get the result script (or nullptr on failure).
|
|
* - CancelOffThreadScript, to free the resources without creating a script.
|
|
*
|
|
* The characters passed in to CompileOffThread must remain live until the
|
|
* callback is invoked, and the resulting script will be rooted until the call
|
|
* to FinishOffThreadScript.
|
|
*/
|
|
|
|
extern JS_PUBLIC_API bool CanCompileOffThread(
|
|
JSContext* cx, const ReadOnlyCompileOptions& options, size_t length);
|
|
|
|
extern JS_PUBLIC_API bool CompileOffThread(
|
|
JSContext* cx, const ReadOnlyCompileOptions& options,
|
|
SourceText<char16_t>& srcBuf, OffThreadCompileCallback callback,
|
|
void* callbackData);
|
|
|
|
// NOTE: Unlike for the normal sync compilation functions, this function NEVER
|
|
// INFLATES TO UTF-16. Therefore, it is ALWAYS invoking experimental
|
|
// UTF-8 support. Inflate to UTF-16 yourself and use the other overload
|
|
// if you're unable to take a risk using unstable functionality.
|
|
extern JS_PUBLIC_API bool CompileOffThread(
|
|
JSContext* cx, const ReadOnlyCompileOptions& options,
|
|
SourceText<mozilla::Utf8Unit>& srcBuf, OffThreadCompileCallback callback,
|
|
void* callbackData);
|
|
|
|
extern JS_PUBLIC_API JSScript* FinishOffThreadScript(JSContext* cx,
|
|
OffThreadToken* token);
|
|
|
|
extern JS_PUBLIC_API void CancelOffThreadScript(JSContext* cx,
|
|
OffThreadToken* token);
|
|
|
|
extern JS_PUBLIC_API bool CompileOffThreadModule(
|
|
JSContext* cx, const ReadOnlyCompileOptions& options,
|
|
SourceText<char16_t>& srcBuf, OffThreadCompileCallback callback,
|
|
void* callbackData);
|
|
|
|
// NOTE: Unlike for the normal sync compilation functions, this function NEVER
|
|
// INFLATES TO UTF-16. Therefore, it is ALWAYS invoking experimental
|
|
// UTF-8 support. Inflate to UTF-16 yourself and use the other overload
|
|
// if you're unable to take a risk using unstable functionality.
|
|
extern JS_PUBLIC_API bool CompileOffThreadModule(
|
|
JSContext* cx, const ReadOnlyCompileOptions& options,
|
|
SourceText<mozilla::Utf8Unit>& srcBuf, OffThreadCompileCallback callback,
|
|
void* callbackData);
|
|
|
|
extern JS_PUBLIC_API JSObject* FinishOffThreadModule(JSContext* cx,
|
|
OffThreadToken* token);
|
|
|
|
extern JS_PUBLIC_API void CancelOffThreadModule(JSContext* cx,
|
|
OffThreadToken* token);
|
|
|
|
extern JS_PUBLIC_API bool CanDecodeOffThread(
|
|
JSContext* cx, const ReadOnlyCompileOptions& options, size_t length);
|
|
|
|
extern JS_PUBLIC_API bool DecodeOffThreadScript(
|
|
JSContext* cx, const ReadOnlyCompileOptions& options,
|
|
mozilla::Vector<uint8_t>& buffer /* TranscodeBuffer& */, size_t cursor,
|
|
OffThreadCompileCallback callback, void* callbackData);
|
|
|
|
extern JS_PUBLIC_API bool DecodeOffThreadScript(
|
|
JSContext* cx, const ReadOnlyCompileOptions& options,
|
|
const mozilla::Range<uint8_t>& range /* TranscodeRange& */,
|
|
OffThreadCompileCallback callback, void* callbackData);
|
|
|
|
extern JS_PUBLIC_API JSScript* FinishOffThreadScriptDecoder(
|
|
JSContext* cx, OffThreadToken* token);
|
|
|
|
extern JS_PUBLIC_API void CancelOffThreadScriptDecoder(JSContext* cx,
|
|
OffThreadToken* token);
|
|
|
|
extern JS_PUBLIC_API bool DecodeMultiOffThreadScripts(
|
|
JSContext* cx, const ReadOnlyCompileOptions& options,
|
|
mozilla::Vector<TranscodeSource>& sources,
|
|
OffThreadCompileCallback callback, void* callbackData);
|
|
|
|
extern JS_PUBLIC_API bool FinishMultiOffThreadScriptsDecoder(
|
|
JSContext* cx, OffThreadToken* token,
|
|
MutableHandle<GCVector<JSScript*>> scripts);
|
|
|
|
extern JS_PUBLIC_API void CancelMultiOffThreadScriptsDecoder(
|
|
JSContext* cx, OffThreadToken* token);
|
|
|
|
// This returns false if built without JS_BUILD_BINAST.
|
|
extern JS_PUBLIC_API bool CanDecodeBinASTOffThread(
|
|
JSContext* cx, const ReadOnlyCompileOptions& options, size_t length);
|
|
|
|
// This throws an exception if built without JS_BUILD_BINAST.
|
|
extern JS_PUBLIC_API bool DecodeBinASTOffThread(
|
|
JSContext* cx, const ReadOnlyCompileOptions& options, const uint8_t* buf,
|
|
size_t length, JS::BinASTFormat format, OffThreadCompileCallback callback,
|
|
void* callbackData);
|
|
|
|
// This throws an exception if built without JS_BUILD_BINAST.
|
|
extern JS_PUBLIC_API JSScript* FinishOffThreadBinASTDecode(
|
|
JSContext* cx, OffThreadToken* token);
|
|
|
|
} // namespace JS
|
|
|
|
#endif /* js_OffThreadScriptCompilation_h */
|