trace-trait.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_TRACE_TRAIT_H_
#define INCLUDE_CPPGC_TRACE_TRAIT_H_
 
#include <type_traits>
 
#include "cppgc/type-traits.h"
#include "v8config.h"  // NOLINT(build/include_directory)
 
namespace cppgc {
 
class Visitor;
 
namespace internal {
 
class RootVisitor;
 
using TraceRootCallback = void (*)(RootVisitor&, const void* object);
 
// Implementation of the default TraceTrait handling GarbageCollected and
// GarbageCollectedMixin.
template <typename T,
          bool =
              IsGarbageCollectedMixinTypeV<typename std::remove_const<T>::type>>
struct TraceTraitImpl;
 
}  // namespace internal

using TraceCallback = void (*)(Visitor* visitor, const void* object);

struct TraceDescriptor {
  const void* base_object_payload;
  TraceCallback callback;
};

using TraceDescriptorCallback = TraceDescriptor (*)(const void* address);
 
namespace internal {
 
struct V8_EXPORT TraceTraitFromInnerAddressImpl {
  static TraceDescriptor GetTraceDescriptor(const void* address);
};

template <typename T>
struct TraceTraitBase {
  static_assert(internal::IsTraceableV<T>, "T must have a Trace() method");

  static TraceDescriptor GetTraceDescriptor(const void* self) {
    return internal::TraceTraitImpl<T>::GetTraceDescriptor(
        static_cast<const T*>(self));
  }

  static void Trace(Visitor* visitor, const void* self) {
    static_cast<const T*>(self)->Trace(visitor);
  }
};
 
}  // namespace internal
 
template <typename T>
struct TraceTrait : public internal::TraceTraitBase<T> {};
 
namespace internal {
 
template <typename T>
struct TraceTraitImpl<T, false> {
  static_assert(IsGarbageCollectedTypeV<T>,
                "T must be of type GarbageCollected or GarbageCollectedMixin");
  static TraceDescriptor GetTraceDescriptor(const void* self) {
    return {self, TraceTrait<T>::Trace};
  }
};
 
template <typename T>
struct TraceTraitImpl<T, true> {
  static TraceDescriptor GetTraceDescriptor(const void* self) {
    return internal::TraceTraitFromInnerAddressImpl::GetTraceDescriptor(self);
  }
};
 
}  // namespace internal
}  // namespace cppgc
 
#endif  // INCLUDE_CPPGC_TRACE_TRAIT_H_