dmaax/ladybird
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
ladybird/Libraries/LibJS/Runtime/Error.h

94 lines
3.2 KiB
C
Raw Normal View History

LibJS: Implement basic exception throwing You can now throw exceptions by calling Interpreter::throw_exception(). Anyone who calls ASTNode::execute() needs to check afterwards if the Interpreter now has an exception(), and if so, stop what they're doing and simply return. When catching an exception, we'll first execute the CatchClause node if present. After that, we'll execute the finalizer block if present. This is unlikely to be completely correct, but it's a start! :^)
2020-03-24 10:37:39 -03:00
/*
Meta: Update my e-mail address everywhere
2024-10-04 08:19:50 -03:00
* Copyright (c) 2020, Andreas Kling <andreas@ladybird.org>
LibJS: Convert Error::create() to NonnullGCPtr
2022-12-13 17:49:50 -03:00
* Copyright (c) 2021-2022, Linus Groh <linusg@serenityos.org>
LibJS: Implement basic exception throwing You can now throw exceptions by calling Interpreter::throw_exception(). Anyone who calls ASTNode::execute() needs to check afterwards if the Interpreter now has an exception(), and if so, stop what they're doing and simply return. When catching an exception, we'll first execute the CatchClause node if present. After that, we'll execute the finalizer block if present. This is unlikely to be completely correct, but it's a start! :^)
2020-03-24 10:37:39 -03:00
*
Everything: Move to SPDX license identifiers in all files. SPDX License Identifiers are a more compact / standardized way of representing file license information. See: https://spdx.dev/resources/use/#identifiers This was done with the `ambr` search and replace tool. ambr --no-parent-ignore --key-from-file --rep-from-file key.txt rep.txt *
2021-04-22 05:24:48 -03:00
* SPDX-License-Identifier: BSD-2-Clause
LibJS: Implement basic exception throwing You can now throw exceptions by calling Interpreter::throw_exception(). Anyone who calls ASTNode::execute() needs to check afterwards if the Interpreter now has an exception(), and if so, stop what they're doing and simply return. When catching an exception, we'll first execute the CatchClause node if present. After that, we'll execute the finalizer block if present. This is unlikely to be completely correct, but it's a start! :^)
2020-03-24 10:37:39 -03:00
*/
LibJS: Add all the Error subclasses This patch adds instance, constructor and prototype classes for: - EvalError - InternalError - RangeError - ReferenceError - SyntaxError - TypeError - URIError Enumerator macros are used to reduce the amount of typing. :^)
2020-04-10 07:42:33 -03:00
#pragma once
LibJS+LibWeb+WebContent: Port JS::PropertyKey to UTF-16 This has quite a lot of fall out. But the majority of it is just type or UDL substitution, where the changes just fall through to other function calls. By changing property key storage to UTF-16, the main affected areas are: * NativeFunction names must now be UTF-16 * Bytecode identifiers must now be UTF-16 * Module/binding names must now be UTF-16
2025-08-02 20:27:29 -03:00
#include <AK/FlyString.h>
LibJS+Everywhere: Convert JS::Error to String This includes an Error::create overload to create an Error from a UTF-8 StringView. If creating a String from that view fails, the factory will return an OOM InternalError instead. VM::throw_completion can also make use of this overload via its perfect forwarding.
2023-02-16 16:09:11 -03:00
#include <AK/String.h>
LibJS+LibWeb: Port interned bytecode strings to UTF-16 This was almost a no-op, except we intern JS exception messages. So the bulk of this patch is porting exception messages to UTF-16.
2025-08-07 20:31:52 -03:00
#include <AK/Utf16String.h>
LibJS: Enable EXPLICIT_SYMBOL_EXPORT and annotate minimum symbol set
2025-07-19 17:49:30 -03:00
#include <LibJS/Export.h>
LibJS: Convert install_error_cause() to ThrowCompletionOr
2021-10-02 12:03:45 -03:00
#include <LibJS/Runtime/Completion.h>
LibJS: Implement basic exception throwing You can now throw exceptions by calling Interpreter::throw_exception(). Anyone who calls ASTNode::execute() needs to check afterwards if the Interpreter now has an exception(), and if so, stop what they're doing and simply return. When catching an exception, we'll first execute the CatchClause node if present. After that, we'll execute the finalizer block if present. This is unlikely to be completely correct, but it's a start! :^)
2020-03-24 10:37:39 -03:00
#include <LibJS/Runtime/Object.h>
LibJS: Add a traceback to Error Since we have the traceback we now also generate the stack string on demand instead of immediately on construction.
2022-02-07 10:48:09 -03:00
#include <LibJS/SourceRange.h>
LibJS: Implement basic exception throwing You can now throw exceptions by calling Interpreter::throw_exception(). Anyone who calls ASTNode::execute() needs to check afterwards if the Interpreter now has an exception(), and if so, stop what they're doing and simply return. When catching an exception, we'll first execute the CatchClause node if present. After that, we'll execute the finalizer block if present. This is unlikely to be completely correct, but it's a start! :^)
2020-03-24 10:37:39 -03:00
namespace JS {
LibJS: Enable EXPLICIT_SYMBOL_EXPORT and annotate minimum symbol set
2025-07-19 17:49:30 -03:00
struct JS_API TracebackFrame {
LibJS: Remove ExecutionContext::function_name field Instead of having ExecutionContext track function names separately, we give FunctionObject a virtual function that returns an appropriate name string for use in call stacks.
2025-10-29 04:28:41 -03:00
Utf16String function_name;
LibJS: Make Error stack traces lazier Instead of eagerly populating the stack trace with a textual representation of every call frame, just store the raw source code range (code, start offset, end offset). From that, we can generate the full rich backtrace when requested, and save ourselves the trouble otherwise. This makes test-wasm take ~7 seconds on my machine instead of ~60. :^)
2023-05-28 03:28:43 -03:00
[[nodiscard]] SourceRange const& source_range() const;
LibJS: Don't use GC::Root unnecessarily in Error stack traces This was causing a fair bit of root registration churn on pages that throw lots of errors. Since there's no need for these pointers to float around freely, we can just visit them during the mark phase as usual.
2025-11-30 06:21:50 -03:00
GC::Ptr<CachedSourceRange> cached_source_range;
LibJS: Add a traceback to Error Since we have the traceback we now also generate the stack string on demand instead of immediately on construction.
2022-02-07 10:48:09 -03:00
};
LibJS+Embedders: Unify stack trace format for uncaught errors Previously these handlers duplicated code and used formats that were different from the one Error.prototype.stack uses. Now they use the same Error::stack_string function, which accepts a new parameter for compacting stack traces with repeating frames.
2023-10-31 17:55:17 -03:00
enum CompactTraceback {
No,
Yes,
};
LibJS: Enable EXPLICIT_SYMBOL_EXPORT and annotate minimum symbol set
2025-07-19 17:49:30 -03:00
class JS_API Error : public Object {
LibJS+LibWeb: Add JS::Object::inherits(class_name) To allow implementing the DOM class hierarchy in JS bindings, this patch adds an inherits() function that can be used to ask an Object if it inherits from a specific C++ class (by name). The necessary overrides are baked into each Object subclass by the new JS_OBJECT macro, which works similarly to C_OBJECT in LibCore. Thanks to @Dexesttp for suggesting this approach. :^)
2020-06-21 10:14:02 -03:00
JS_OBJECT(Error, Object);
LibGC+Everywhere: Factor out a LibGC from LibJS Resulting in a massive rename across almost everywhere! Alongside the namespace change, we now have the following names: * JS::NonnullGCPtr -> GC::Ref * JS::GCPtr -> GC::Ptr * JS::HeapFunction -> GC::Function * JS::CellImpl -> GC::Cell * JS::Handle -> GC::Root
2024-11-14 12:01:23 -03:00
GC_DECLARE_ALLOCATOR(Error);
LibJS+LibWeb: Add JS::Object::inherits(class_name) To allow implementing the DOM class hierarchy in JS bindings, this patch adds an inherits() function that can be used to ask an Object if it inherits from a specific C++ class (by name). The necessary overrides are baked into each Object subclass by the new JS_OBJECT macro, which works similarly to C_OBJECT in LibCore. Thanks to @Dexesttp for suggesting this approach. :^)
2020-06-21 10:14:02 -03:00
LibJS: Implement basic exception throwing You can now throw exceptions by calling Interpreter::throw_exception(). Anyone who calls ASTNode::execute() needs to check afterwards if the Interpreter now has an exception(), and if so, stop what they're doing and simply return. When catching an exception, we'll first execute the CatchClause node if present. After that, we'll execute the finalizer block if present. This is unlikely to be completely correct, but it's a start! :^)
2020-03-24 10:37:39 -03:00
public:
LibGC+Everywhere: Factor out a LibGC from LibJS Resulting in a massive rename across almost everywhere! Alongside the namespace change, we now have the following names: * JS::NonnullGCPtr -> GC::Ref * JS::GCPtr -> GC::Ptr * JS::HeapFunction -> GC::Function * JS::CellImpl -> GC::Cell * JS::Handle -> GC::Root
2024-11-14 12:01:23 -03:00
static GC::Ref<Error> create(Realm&);
LibJS+LibWeb: Port interned bytecode strings to UTF-16 This was almost a no-op, except we intern JS exception messages. So the bulk of this patch is porting exception messages to UTF-16.
2025-08-07 20:31:52 -03:00
static GC::Ref<Error> create(Realm&, Utf16String message);
LibGC+Everywhere: Factor out a LibGC from LibJS Resulting in a massive rename across almost everywhere! Alongside the namespace change, we now have the following names: * JS::NonnullGCPtr -> GC::Ref * JS::GCPtr -> GC::Ptr * JS::HeapFunction -> GC::Function * JS::CellImpl -> GC::Cell * JS::Handle -> GC::Root
2024-11-14 12:01:23 -03:00
static GC::Ref<Error> create(Realm&, StringView message);
LibJS: Pass prototype to Error constructors
2020-04-17 14:31:48 -03:00
LibJS: Make Errors fully spec compliant The previous handling of the name and message properties specifically was breaking websites that created their own error types and relied on the error prototype working correctly - not assuming an JS::Error this object, that is. The way it works now, and it is supposed to work, is: - Error.prototype.name and Error.prototype.message just have initial string values and are no longer getters/setters - When constructing an error with a message, we create a regular property on the newly created object, so a lookup of the message property will either get it from the object directly or go though the prototype chain - Internal m_name/m_message properties are no longer needed and removed This makes printing errors slightly more complicated, as we can no longer rely on the (safe) internal properties, and cannot trust a property lookup either - get_without_side_effects() is used to solve this, it's not perfect but something we can revisit later. I did some refactoring along the way, there was some really old stuff in there - accessing vm.call_frame().arguments[0] is not something we (have to) do anymore :^) Fixes #6245.
2021-04-11 19:08:28 -03:00
virtual ~Error() override = default;
LibJS: Move install_error_cause() from Object to Error This is only used by Error and its subclasses, so it doesn't need to be available to all objects.
2021-06-26 15:06:55 -03:00
LibJS+Embedders: Unify stack trace format for uncaught errors Previously these handlers duplicated code and used formats that were different from the one Error.prototype.stack uses. Now they use the same Error::stack_string function, which accepts a new parameter for compacting stack traces with repeating frames.
2023-10-31 17:55:17 -03:00
[[nodiscard]] String stack_string(CompactTraceback compact = CompactTraceback::No) const;
LibJS: Implement non standard error.stack attribute All other browser already support this feature. There is a Stage 1 proposal to standardize this, but it does not seem to be active.
2022-02-06 13:00:28 -03:00
LibJS: Convert install_error_cause() to ThrowCompletionOr
2021-10-02 12:03:45 -03:00
ThrowCompletionOr<void> install_error_cause(Value options);
LibJS: Implement non standard error.stack attribute All other browser already support this feature. There is a Stage 1 proposal to standardize this, but it does not seem to be active.
2022-02-06 13:00:28 -03:00
LibJS+LibWeb: Port interned bytecode strings to UTF-16 This was almost a no-op, except we intern JS exception messages. So the bulk of this patch is porting exception messages to UTF-16.
2025-08-07 20:31:52 -03:00
void set_message(Utf16String);
LibJS: Allow assigning an error message after Error object creation This will be used by structured deserialization in LibWeb.
2025-07-17 10:48:16 -03:00
LibJS: Add a traceback to Error Since we have the traceback we now also generate the stack string on demand instead of immediately on construction.
2022-02-07 10:48:09 -03:00
Vector<TracebackFrame, 32> const& traceback() const { return m_traceback; }
LibJS: Cache the formatted Error.prototype.stack string Generating the stack trace string is expensive as it involves formatting each frame with function names, file paths, and line numbers. Since the stack trace is immutable after error creation, we can cache the formatted string on first access. This matches the caching behavior of V8 and JavaScriptCore, which also return the same cached string on subsequent accesses to the stack property.
2026-01-18 07:48:29 -03:00
void set_cached_string(GC::Ref<PrimitiveString> string) { m_cached_string = string; }
GC::Ptr<PrimitiveString> cached_string() const { return m_cached_string; }
LibJS: Hide all the constructors! Now that the GC allocator is able to invoke Cell subclass constructors directly via friendship, we no longer need to keep them public. :^)
2022-08-28 18:51:28 -03:00
protected:
explicit Error(Object& prototype);
LibJS: Don't use GC::Root unnecessarily in Error stack traces This was causing a fair bit of root registration churn on pages that throw lots of errors. Since there's no need for these pointers to float around freely, we can just visit them during the mark phase as usual.
2025-11-30 06:21:50 -03:00
virtual void visit_edges(Visitor&) override;
LibJS: Implement non standard error.stack attribute All other browser already support this feature. There is a Stage 1 proposal to standardize this, but it does not seem to be active.
2022-02-06 13:00:28 -03:00
private:
LibJS: Avoid naming conflict between Object's and Error's is_error Object defines an is_error virtual method to be overridden by Error for fast-is. This is the same name as the Error.isError constructor method. Rename the former to avoid conflicts, as GCC 15 just started warning on this.
2025-04-26 09:07:22 -03:00
virtual bool is_error_object() const final { return true; }
LibJS: Add fast_is<T> helpers for all the primitive wrapper objects The JS runtime is full of checks for is<NumberObject> and friends. They were showing up in a Speedometer profile as ~1% spent in dynamic_cast, and this basically chops that down to nothing.
2025-03-25 05:34:06 -03:00
LibJS: Implement non standard error.stack attribute All other browser already support this feature. There is a Stage 1 proposal to standardize this, but it does not seem to be active.
2022-02-06 13:00:28 -03:00
void populate_stack();
LibJS: Add a traceback to Error Since we have the traceback we now also generate the stack string on demand instead of immediately on construction.
2022-02-07 10:48:09 -03:00
Vector<TracebackFrame, 32> m_traceback;
LibJS: Cache the formatted Error.prototype.stack string Generating the stack trace string is expensive as it involves formatting each frame with function names, file paths, and line numbers. Since the stack trace is immutable after error creation, we can cache the formatted string on first access. This matches the caching behavior of V8 and JavaScriptCore, which also return the same cached string on subsequent accesses to the stack property.
2026-01-18 07:48:29 -03:00
GC::Ptr<PrimitiveString> m_cached_string;
LibJS: Implement basic exception throwing You can now throw exceptions by calling Interpreter::throw_exception(). Anyone who calls ASTNode::execute() needs to check afterwards if the Interpreter now has an exception(), and if so, stop what they're doing and simply return. When catching an exception, we'll first execute the CatchClause node if present. After that, we'll execute the finalizer block if present. This is unlikely to be completely correct, but it's a start! :^)
2020-03-24 10:37:39 -03:00
};
LibJS: Add fast_is<T> helpers for all the primitive wrapper objects The JS runtime is full of checks for is<NumberObject> and friends. They were showing up in a Speedometer profile as ~1% spent in dynamic_cast, and this basically chops that down to nothing.
2025-03-25 05:34:06 -03:00
template<>
LibJS: Avoid naming conflict between Object's and Error's is_error Object defines an is_error virtual method to be overridden by Error for fast-is. This is the same name as the Error.isError constructor method. Rename the former to avoid conflicts, as GCC 15 just started warning on this.
2025-04-26 09:07:22 -03:00
inline bool Object::fast_is<Error>() const { return is_error_object(); }
LibJS: Add fast_is<T> helpers for all the primitive wrapper objects The JS runtime is full of checks for is<NumberObject> and friends. They were showing up in a Speedometer profile as ~1% spent in dynamic_cast, and this basically chops that down to nothing.
2025-03-25 05:34:06 -03:00
LibJS: Rename JS_ENUMERATE_{ERROR_SUBCLASSES => NATIVE_ERRORS} The fact that they *are* subclasses is an implementation detail and should not be highlighted. The spec calls these NativeErrors, so let's use that. Also added a comment explaining *why* they inherit from Error - I was about to change that :^)
2021-06-11 13:54:42 -03:00
// NOTE: Making these inherit from Error is not required by the spec but
// our way of implementing the [[ErrorData]] internal slot, which is
// used in Object.prototype.toString().
LibJS: Stop propagating small OOM errors from the Error object
2023-09-06 09:18:01 -03:00
#define DECLARE_NATIVE_ERROR(ClassName, snake_name, PrototypeName, ConstructorName) \
LibJS: Enable EXPLICIT_SYMBOL_EXPORT and annotate minimum symbol set
2025-07-19 17:49:30 -03:00
class JS_API ClassName final : public Error { \
LibJS: Stop propagating small OOM errors from the Error object
2023-09-06 09:18:01 -03:00
JS_OBJECT(ClassName, Error); \
LibGC+Everywhere: Factor out a LibGC from LibJS Resulting in a massive rename across almost everywhere! Alongside the namespace change, we now have the following names: * JS::NonnullGCPtr -> GC::Ref * JS::GCPtr -> GC::Ptr * JS::HeapFunction -> GC::Function * JS::CellImpl -> GC::Cell * JS::Handle -> GC::Root
2024-11-14 12:01:23 -03:00
GC_DECLARE_ALLOCATOR(ClassName); \
LibJS: Stop propagating small OOM errors from the Error object
2023-09-06 09:18:01 -03:00
\
public: \
LibGC+Everywhere: Factor out a LibGC from LibJS Resulting in a massive rename across almost everywhere! Alongside the namespace change, we now have the following names: * JS::NonnullGCPtr -> GC::Ref * JS::GCPtr -> GC::Ptr * JS::HeapFunction -> GC::Function * JS::CellImpl -> GC::Cell * JS::Handle -> GC::Root
2024-11-14 12:01:23 -03:00
static GC::Ref<ClassName> create(Realm&); \
LibJS+LibWeb: Port interned bytecode strings to UTF-16 This was almost a no-op, except we intern JS exception messages. So the bulk of this patch is porting exception messages to UTF-16.
2025-08-07 20:31:52 -03:00
static GC::Ref<ClassName> create(Realm&, Utf16String message); \
LibGC+Everywhere: Factor out a LibGC from LibJS Resulting in a massive rename across almost everywhere! Alongside the namespace change, we now have the following names: * JS::NonnullGCPtr -> GC::Ref * JS::GCPtr -> GC::Ptr * JS::HeapFunction -> GC::Function * JS::CellImpl -> GC::Cell * JS::Handle -> GC::Root
2024-11-14 12:01:23 -03:00
static GC::Ref<ClassName> create(Realm&, StringView message); \
LibJS: Stop propagating small OOM errors from the Error object
2023-09-06 09:18:01 -03:00
\
explicit ClassName(Object& prototype); \
virtual ~ClassName() override = default; \
LibJS: Add all the Error subclasses This patch adds instance, constructor and prototype classes for: - EvalError - InternalError - RangeError - ReferenceError - SyntaxError - TypeError - URIError Enumerator macros are used to reduce the amount of typing. :^)
2020-04-10 07:42:33 -03:00
};
LibJS: Add six typed arrays (signed and unsigned 8/16/32-bit) This patch adds six of the standard type arrays and tries to share as much code as possible: - Uint8Array - Uint16Array - Uint32Array - Int8Array - Int16Array - Int32Array
2020-12-01 17:05:25 -03:00
#define __JS_ENUMERATE(ClassName, snake_name, PrototypeName, ConstructorName, ArrayType) \
LibJS: Rename JS_ENUMERATE_{ERROR_SUBCLASSES => NATIVE_ERRORS} The fact that they *are* subclasses is an implementation detail and should not be highlighted. The spec calls these NativeErrors, so let's use that. Also added a comment explaining *why* they inherit from Error - I was about to change that :^)
2021-06-11 13:54:42 -03:00
DECLARE_NATIVE_ERROR(ClassName, snake_name, PrototypeName, ConstructorName)
JS_ENUMERATE_NATIVE_ERRORS
LibJS: Use enumerator macros for boilerplate code around native types
2020-04-10 09:06:52 -03:00
#undef __JS_ENUMERATE
Meta: Enforce newlines around namespaces This has come up several times during code review, so let's just enforce it using a new clang-format 20 option.
2025-05-13 08:06:33 -03:00
LibJS: Implement basic exception throwing You can now throw exceptions by calling Interpreter::throw_exception(). Anyone who calls ASTNode::execute() needs to check afterwards if the Interpreter now has an exception(), and if so, stop what they're doing and simply return. When catching an exception, we'll first execute the CatchClause node if present. After that, we'll execute the finalizer block if present. This is unlikely to be completely correct, but it's a start! :^)
2020-03-24 10:37:39 -03:00
}
Reference in a new issue Copy permalink