summaryrefslogtreecommitdiff
path: root/Userland/Libraries/LibJS/Runtime/Error.h
blob: 0422003e167872363de88a55dc9c87b5c76d3b89 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
/*
 * Copyright (c) 2020, Andreas Kling <kling@serenityos.org>
 * Copyright (c) 2021-2022, Linus Groh <linusg@serenityos.org>
 *
 * SPDX-License-Identifier: BSD-2-Clause
 */

#pragma once

#include <AK/DeprecatedFlyString.h>
#include <LibJS/Runtime/Completion.h>
#include <LibJS/Runtime/Object.h>
#include <LibJS/SourceRange.h>

namespace JS {

struct TracebackFrame {
    DeprecatedFlyString function_name;
    SourceRange source_range;
};

class Error : public Object {
    JS_OBJECT(Error, Object);

public:
    static NonnullGCPtr<Error> create(Realm&);
    static NonnullGCPtr<Error> create(Realm&, DeprecatedString const& message);

    virtual ~Error() override = default;

    [[nodiscard]] DeprecatedString stack_string() const;

    ThrowCompletionOr<void> install_error_cause(Value options);

    Vector<TracebackFrame, 32> const& traceback() const { return m_traceback; }

protected:
    explicit Error(Object& prototype);

private:
    void populate_stack();
    Vector<TracebackFrame, 32> m_traceback;
};

// 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().
#define DECLARE_NATIVE_ERROR(ClassName, snake_name, PrototypeName, ConstructorName)     \
    class ClassName final : public Error {                                              \
        JS_OBJECT(ClassName, Error);                                                    \
                                                                                        \
    public:                                                                             \
        static NonnullGCPtr<ClassName> create(Realm&);                                  \
        static NonnullGCPtr<ClassName> create(Realm&, DeprecatedString const& message); \
                                                                                        \
        explicit ClassName(Object& prototype);                                          \
        virtual ~ClassName() override = default;                                        \
    };

#define __JS_ENUMERATE(ClassName, snake_name, PrototypeName, ConstructorName, ArrayType) \
    DECLARE_NATIVE_ERROR(ClassName, snake_name, PrototypeName, ConstructorName)
JS_ENUMERATE_NATIVE_ERRORS
#undef __JS_ENUMERATE
}