REDROOM

Navigation

Breadcrumbs

Create

Preview: prefinalizer.h Size: 2.88 KB

//opt/cpanel/ea-nodejs20/include/node/cppgc/prefinalizer.h

// Copyright 2020 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 INCLUDE_CPPGC_PREFINALIZER_H_
#define INCLUDE_CPPGC_PREFINALIZER_H_

#include "cppgc/internal/compiler-specific.h"
#include "cppgc/liveness-broker.h"

namespace cppgc {

namespace internal {

class V8_EXPORT PrefinalizerRegistration final {
 public:
  using Callback = bool (*)(const cppgc::LivenessBroker&, void*);

  PrefinalizerRegistration(void*, Callback);

  void* operator new(size_t, void* location) = delete;
  void* operator new(size_t) = delete;
};

}  // namespace internal

/**
 * Macro must be used in the private section of `Class` and registers a
 * prefinalization callback `void Class::PreFinalizer()`. The callback is
 * invoked on garbage collection after the collector has found an object to be
 * dead.
 *
 * Callback properties:
 * - The callback is invoked before a possible destructor for the corresponding
 *   object.
 * - The callback may access the whole object graph, irrespective of whether
 *   objects are considered dead or alive.
 * - The callback is invoked on the same thread as the object was created on.
 *
 * Example:
 * \code
 * class WithPrefinalizer : public GarbageCollected<WithPrefinalizer> {
 *   CPPGC_USING_PRE_FINALIZER(WithPrefinalizer, Dispose);
 *
 *  public:
 *   void Trace(Visitor*) const {}
 *   void Dispose() { prefinalizer_called = true; }
 *   ~WithPrefinalizer() {
 *     // prefinalizer_called == true
 *   }
 *  private:
 *   bool prefinalizer_called = false;
 * };
 * \endcode
 */
#define CPPGC_USING_PRE_FINALIZER(Class, PreFinalizer)                         \
 public:                                                                       \
  static bool InvokePreFinalizer(const cppgc::LivenessBroker& liveness_broker, \
                                 void* object) {                               \
    static_assert(cppgc::IsGarbageCollectedOrMixinTypeV<Class>,                \
                  "Only garbage collected objects can have prefinalizers");    \
    Class* self = static_cast<Class*>(object);                                 \
    if (liveness_broker.IsHeapObjectAlive(self)) return false;                 \
    self->PreFinalizer();                                                      \
    return true;                                                               \
  }                                                                            \
                                                                               \
 private:                                                                      \
  CPPGC_NO_UNIQUE_ADDRESS cppgc::internal::PrefinalizerRegistration            \
      prefinalizer_dummy_{this, Class::InvokePreFinalizer};                    \
  static_assert(true, "Force semicolon.")

}  // namespace cppgc

#endif  // INCLUDE_CPPGC_PREFINALIZER_H_

Name	Size	Perms	Modified	Actions
internal DIR	-	drwxr-xr-x	2026-02-03 09:33:34	Edit Download recursive recursive
allocation.h	11.61 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
common.h	643 B	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
cross-thread-persistent.h	14.81 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
custom-space.h	2.40 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
default-platform.h	2.18 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
ephemeron-pair.h	804 B	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
explicit-management.h	3.29 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
garbage-collected.h	3.11 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
heap-consistency.h	11.74 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
heap-handle.h	1.26 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
heap-state.h	2.57 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
heap-statistics.h	3.89 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
heap.h	5.70 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
liveness-broker.h	2.34 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
macros.h	1.31 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
member.h	22.75 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
name-provider.h	1.99 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
object-size-trait.h	1.60 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
persistent.h	13.50 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
platform.h	5.56 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
prefinalizer.h	2.88 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
process-heap-statistics.h	1009 B	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
sentinel-pointer.h	935 B	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
source-location.h	2.57 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
testing.h	2.96 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
trace-trait.h	3.14 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
type-traits.h	7.78 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
visitor.h	14.84 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive

Directory Contents