garbage-collected.h

Go to the documentation of this file.

// 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_GARBAGE_COLLECTED_H_
#define INCLUDE_CPPGC_GARBAGE_COLLECTED_H_
 
#include "cppgc/internal/api-constants.h"
#include "cppgc/platform.h"
#include "cppgc/trace-trait.h"
#include "cppgc/type-traits.h"
 
namespace cppgc {
 
class Visitor;
 
template <typename T>
class GarbageCollected {
 public:
  using IsGarbageCollectedTypeMarker = void;
  using ParentMostGarbageCollectedType = T;
 
  // Must use MakeGarbageCollected.
  void* operator new(size_t) = delete;
  void* operator new[](size_t) = delete;
  // The garbage collector is taking care of reclaiming the object. Also,
  // virtual destructor requires an unambiguous, accessible 'operator delete'.
  void operator delete(void*) {
#ifdef V8_ENABLE_CHECKS
    internal::Fatal(
        "Manually deleting a garbage collected object is not allowed");
#endif  // V8_ENABLE_CHECKS
  }
  void operator delete[](void*) = delete;
 
 protected:
  GarbageCollected() = default;
};
 
class GarbageCollectedMixin {
 public:
  using IsGarbageCollectedMixinTypeMarker = void;
 
  // Must use MakeGarbageCollected.
  void* operator new(size_t) = delete;
  void* operator new[](size_t) = delete;
  // The garbage collector is taking care of reclaiming the object.
  // Not override the non-array varaint of `delete` to not conflict with the
  // operator in GarbageCollected above.
  void operator delete[](void*) = delete;
 
  virtual void Trace(cppgc::Visitor*) const {}
};
 
}  // namespace cppgc
 
#endif  // INCLUDE_CPPGC_GARBAGE_COLLECTED_H_