js-promise.h 3.5 KB
Newer Older
1 2 3 4 5 6 7
// Copyright 2018 the V8 project authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef V8_OBJECTS_JS_PROMISE_H_
#define V8_OBJECTS_JS_PROMISE_H_

8
#include "include/v8-promise.h"
9
#include "src/objects/js-objects.h"
10
#include "src/objects/promise.h"
11
#include "torque-generated/bit-fields.h"
12 13 14 15 16 17 18

// Has to be the last include (doesn't have include guards):
#include "src/objects/object-macros.h"

namespace v8 {
namespace internal {

19 20
#include "torque-generated/src/objects/js-promise-tq.inc"

21 22 23 24 25 26 27 28 29 30
// Representation of promise objects in the specification. Our layout of
// JSPromise differs a bit from the layout in the specification, for example
// there's only a single list of PromiseReaction objects, instead of separate
// lists for fulfill and reject reactions. The PromiseReaction carries both
// callbacks from the start, and is eventually morphed into the proper kind of
// PromiseReactionJobTask when the JSPromise is settled.
//
// We also overlay the result and reactions fields on the JSPromise, since
// the reactions are only necessary for pending promises, whereas the result
// is only meaningful for settled promises.
31
class JSPromise : public TorqueGeneratedJSPromise<JSPromise, JSObject> {
32 33
 public:
  // [result]: Checks that the promise is settled and returns the result.
34
  inline Object result() const;
35 36

  // [reactions]: Checks that the promise is pending and returns the reactions.
37
  inline Object reactions() const;
38 39 40 41 42 43 44 45

  // [has_handler]: Whether this promise has a reject handler or not.
  DECL_BOOLEAN_ACCESSORS(has_handler)

  // [handled_hint]: Whether this promise will be handled by a catch
  // block in an async function.
  DECL_BOOLEAN_ACCESSORS(handled_hint)

46 47 48 49
  // [is_silent]: Whether this promise should cause the debugger to pause when
  // rejected.
  DECL_BOOLEAN_ACCESSORS(is_silent)

50 51 52
  int async_task_id() const;
  void set_async_task_id(int id);

53
  static const char* Status(Promise::PromiseState status);
54
  V8_EXPORT_PRIVATE Promise::PromiseState status() const;
55 56 57
  void set_status(Promise::PromiseState status);

  // ES section #sec-fulfillpromise
58 59
  V8_EXPORT_PRIVATE static Handle<Object> Fulfill(Handle<JSPromise> promise,
                                                  Handle<Object> value);
60 61 62 63
  // ES section #sec-rejectpromise
  static Handle<Object> Reject(Handle<JSPromise> promise, Handle<Object> reason,
                               bool debug_event = true);
  // ES section #sec-promise-resolve-functions
64 65
  V8_WARN_UNUSED_RESULT static MaybeHandle<Object> Resolve(
      Handle<JSPromise> promise, Handle<Object> resolution);
66 67

  // Dispatched behavior.
68
  DECL_PRINTER(JSPromise)
69 70 71
  DECL_VERIFIER(JSPromise)

  static const int kSizeWithEmbedderFields =
72
      kHeaderSize + v8::Promise::kEmbedderFieldCount * kEmbedderDataSlotSize;
73 74

  // Flags layout.
75 76
  DEFINE_TORQUE_GENERATED_JS_PROMISE_FLAGS()

77 78 79 80 81 82 83 84 85 86
  STATIC_ASSERT(v8::Promise::kPending == 0);
  STATIC_ASSERT(v8::Promise::kFulfilled == 1);
  STATIC_ASSERT(v8::Promise::kRejected == 2);

 private:
  // ES section #sec-triggerpromisereactions
  static Handle<Object> TriggerPromiseReactions(Isolate* isolate,
                                                Handle<Object> reactions,
                                                Handle<Object> argument,
                                                PromiseReaction::Type type);
87

88
  TQ_OBJECT_CONSTRUCTORS(JSPromise)
89 90 91 92 93 94 95 96
};

}  // namespace internal
}  // namespace v8

#include "src/objects/object-macros-undef.h"

#endif  // V8_OBJECTS_JS_PROMISE_H_