v8-embedder-heap.h

Go to the documentation of this file.

// Copyright 2021 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_V8_EMBEDDER_HEAP_H_
#define INCLUDE_V8_EMBEDDER_HEAP_H_
 
#include "v8-traced-handle.h"  // NOLINT(build/include_directory)
#include "v8config.h"          // NOLINT(build/include_directory)
 
namespace v8 {
namespace internal {
class TracedHandles;
}  // namespace internal
 
class Isolate;
class Value;
 
class V8_EXPORT EmbedderRootsHandler {
 public:
  enum class RootHandling {
    kQueryEmbedderForNonDroppableReferences,
    kDontQueryEmbedderForAnyReference,
  };
 
  virtual ~EmbedderRootsHandler() = default;
 
  EmbedderRootsHandler() = default;
  explicit EmbedderRootsHandler(RootHandling default_traced_reference_handling)
      : default_traced_reference_handling_(default_traced_reference_handling) {}
 
  virtual bool IsRoot(const v8::TracedReference<v8::Value>& handle) = 0;
 
  virtual void ResetRoot(const v8::TracedReference<v8::Value>& handle) = 0;
 
  virtual bool TryResetRoot(const v8::TracedReference<v8::Value>& handle) {
    ResetRoot(handle);
    return true;
  }
 
 private:
  const RootHandling default_traced_reference_handling_ =
      RootHandling::kQueryEmbedderForNonDroppableReferences;
 
  friend class internal::TracedHandles;
};
 
}  // namespace v8
 
#endif  // INCLUDE_V8_EMBEDDER_HEAP_H_