Head

GCC Code Coverage Report

Directory:	./		Exec	Total	Coverage
File:	base_object-inl.h	Lines:	103	110	93.6 %
Date:	2022-09-07 04:19:57	Branches:	24	42	57.1 %


// Copyright Joyent, Inc. and other Node contributors.
//
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to permit
// persons to whom the Software is furnished to do so, subject to the
// following conditions:
//
// The above copyright notice and this permission notice shall be included
// in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
// NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
// DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
// USE OR OTHER DEALINGS IN THE SOFTWARE.

#ifndef SRC_BASE_OBJECT_INL_H_
#define SRC_BASE_OBJECT_INL_H_

#if defined(NODE_WANT_INTERNALS) && NODE_WANT_INTERNALS

#include "base_object.h"
#include "env-inl.h"
#include "util.h"

#include "v8.h"

namespace node {

// static
v8::Local<v8::FunctionTemplate> BaseObject::GetConstructorTemplate(
    Environment* env) {
  return BaseObject::GetConstructorTemplate(env->isolate_data());
}

void BaseObject::Detach() {
  CHECK_GT(pointer_data()->strong_ptr_count, 0);
  pointer_data()->is_detached = true;
}

v8::Global<v8::Object>& BaseObject::persistent() {
  return persistent_handle_;
}


v8::Local<v8::Object> BaseObject::object() const {
  return PersistentToLocal::Default(env()->isolate(), persistent_handle_);
}

v8::Local<v8::Object> BaseObject::object(v8::Isolate* isolate) const {
  v8::Local<v8::Object> handle = object();

  DCHECK_EQ(handle->GetCreationContext().ToLocalChecked()->GetIsolate(),
            isolate);
  DCHECK_EQ(env()->isolate(), isolate);

  return handle;
}

Environment* BaseObject::env() const {
  return env_;
}

BaseObject* BaseObject::FromJSObject(v8::Local<v8::Value> value) {
  v8::Local<v8::Object> obj = value.As<v8::Object>();
  DCHECK_GE(obj->InternalFieldCount(), BaseObject::kSlot);
  return static_cast<BaseObject*>(
      obj->GetAlignedPointerFromInternalField(BaseObject::kSlot));
}


template <typename T>
T* BaseObject::FromJSObject(v8::Local<v8::Value> object) {
  return static_cast<T*>(FromJSObject(object));
}

void BaseObject::OnGCCollect() {
  delete this;
}

void BaseObject::ClearWeak() {
  if (has_pointer_data())
    pointer_data()->wants_weak_jsobj = false;

  persistent_handle_.ClearWeak();
}

bool BaseObject::IsWeakOrDetached() const {
  if (persistent_handle_.IsWeak()) return true;

  if (!has_pointer_data()) return false;
  const PointerData* pd = const_cast<BaseObject*>(this)->pointer_data();
  return pd->wants_weak_jsobj || pd->is_detached;
}

template <int Field>
void BaseObject::InternalFieldGet(
    v8::Local<v8::String> property,
    const v8::PropertyCallbackInfo<v8::Value>& info) {
  info.GetReturnValue().Set(info.This()->GetInternalField(Field));
}

template <int Field, bool (v8::Value::* typecheck)() const>
void BaseObject::InternalFieldSet(v8::Local<v8::String> property,
                                  v8::Local<v8::Value> value,
                                  const v8::PropertyCallbackInfo<void>& info) {
  // This could be e.g. value->IsFunction().
  CHECK(((*value)->*typecheck)());
  info.This()->SetInternalField(Field, value);
}

bool BaseObject::has_pointer_data() const {
  return pointer_data_ != nullptr;
}

template <typename T, bool kIsWeak>
BaseObject::PointerData*
BaseObjectPtrImpl<T, kIsWeak>::pointer_data() const {
  if constexpr (kIsWeak) {
    return data_.pointer_data;
  }
  if (get_base_object() == nullptr) {
    return nullptr;
  }
  return get_base_object()->pointer_data();
}

template <typename T, bool kIsWeak>
BaseObject* BaseObjectPtrImpl<T, kIsWeak>::get_base_object() const {
  if constexpr (kIsWeak) {
    if (pointer_data() == nullptr) {
      return nullptr;
    }
    return pointer_data()->self;
  }
  return data_.target;
}

template <typename T, bool kIsWeak>
BaseObjectPtrImpl<T, kIsWeak>::~BaseObjectPtrImpl() {
  if constexpr (kIsWeak) {
    if (pointer_data() != nullptr &&
        --pointer_data()->weak_ptr_count == 0 &&
        pointer_data()->self == nullptr) {
      delete pointer_data();
    }
  } else if (get() != nullptr) {
    get()->decrease_refcount();
  }
}

template <typename T, bool kIsWeak>
BaseObjectPtrImpl<T, kIsWeak>::BaseObjectPtrImpl() {
  data_.target = nullptr;
}

template <typename T, bool kIsWeak>
BaseObjectPtrImpl<T, kIsWeak>::BaseObjectPtrImpl(T* target)
  : BaseObjectPtrImpl() {
  if (target == nullptr) return;
  if constexpr (kIsWeak) {
    data_.pointer_data = target->pointer_data();
    CHECK_NOT_NULL(pointer_data());
    pointer_data()->weak_ptr_count++;
  } else {
    data_.target = target;
    CHECK_NOT_NULL(pointer_data());
    get()->increase_refcount();
  }
}

template <typename T, bool kIsWeak>
template <typename U, bool kW>
BaseObjectPtrImpl<T, kIsWeak>::BaseObjectPtrImpl(
    const BaseObjectPtrImpl<U, kW>& other)
  : BaseObjectPtrImpl(other.get()) {}

template <typename T, bool kIsWeak>
BaseObjectPtrImpl<T, kIsWeak>::BaseObjectPtrImpl(const BaseObjectPtrImpl& other)
  : BaseObjectPtrImpl(other.get()) {}

template <typename T, bool kIsWeak>
template <typename U, bool kW>
BaseObjectPtrImpl<T, kIsWeak>& BaseObjectPtrImpl<T, kIsWeak>::operator=(
    const BaseObjectPtrImpl<U, kW>& other) {
  if (other.get() == get()) return *this;
  this->~BaseObjectPtrImpl();
  return *new (this) BaseObjectPtrImpl(other);
}

template <typename T, bool kIsWeak>
BaseObjectPtrImpl<T, kIsWeak>& BaseObjectPtrImpl<T, kIsWeak>::operator=(
    const BaseObjectPtrImpl& other) {
  if (other.get() == get()) return *this;
  this->~BaseObjectPtrImpl();
  return *new (this) BaseObjectPtrImpl(other);
}

template <typename T, bool kIsWeak>
BaseObjectPtrImpl<T, kIsWeak>::BaseObjectPtrImpl(BaseObjectPtrImpl&& other)
  : data_(other.data_) {
  if constexpr (kIsWeak)
    other.data_.target = nullptr;
  else
    other.data_.pointer_data = nullptr;
}

template <typename T, bool kIsWeak>
BaseObjectPtrImpl<T, kIsWeak>& BaseObjectPtrImpl<T, kIsWeak>::operator=(
    BaseObjectPtrImpl&& other) {
  if (&other == this) return *this;
  this->~BaseObjectPtrImpl();
  return *new (this) BaseObjectPtrImpl(std::move(other));
}

template <typename T, bool kIsWeak>
void BaseObjectPtrImpl<T, kIsWeak>::reset(T* ptr) {
  *this = BaseObjectPtrImpl(ptr);
}

template <typename T, bool kIsWeak>
T* BaseObjectPtrImpl<T, kIsWeak>::get() const {
  return static_cast<T*>(get_base_object());
}

template <typename T, bool kIsWeak>
T& BaseObjectPtrImpl<T, kIsWeak>::operator*() const {
  return *get();
}

template <typename T, bool kIsWeak>
T* BaseObjectPtrImpl<T, kIsWeak>::operator->() const {
  return get();
}

template <typename T, bool kIsWeak>
BaseObjectPtrImpl<T, kIsWeak>::operator bool() const {
  return get() != nullptr;
}

template <typename T, bool kIsWeak>
template <typename U, bool kW>
bool BaseObjectPtrImpl<T, kIsWeak>::operator ==(
    const BaseObjectPtrImpl<U, kW>& other) const {
  return get() == other.get();
}

template <typename T, bool kIsWeak>
template <typename U, bool kW>
bool BaseObjectPtrImpl<T, kIsWeak>::operator !=(
    const BaseObjectPtrImpl<U, kW>& other) const {
  return get() != other.get();
}

template <typename T, typename... Args>
BaseObjectPtr<T> MakeBaseObject(Args&&... args) {
  return BaseObjectPtr<T>(new T(std::forward<Args>(args)...));
}

template <typename T, typename... Args>
BaseObjectPtr<T> MakeDetachedBaseObject(Args&&... args) {
  BaseObjectPtr<T> target = MakeBaseObject<T>(std::forward<Args>(args)...);
  target->Detach();
  return target;
}

}  // namespace node

#endif  // defined(NODE_WANT_INTERNALS) && NODE_WANT_INTERNALS

#endif  // SRC_BASE_OBJECT_INL_H_


Generated by: GCOVR (Version 4.2)

Line	Branch	Exec	Source
1			// Copyright Joyent, Inc. and other Node contributors.
2			//
3			// Permission is hereby granted, free of charge, to any person obtaining a
4			// copy of this software and associated documentation files (the
5			// "Software"), to deal in the Software without restriction, including
6			// without limitation the rights to use, copy, modify, merge, publish,
7			// distribute, sublicense, and/or sell copies of the Software, and to permit
8			// persons to whom the Software is furnished to do so, subject to the
9			// following conditions:
10			//
11			// The above copyright notice and this permission notice shall be included
12			// in all copies or substantial portions of the Software.
13			//
14			// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
15			// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16			// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
17			// NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18			// DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
19			// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20			// USE OR OTHER DEALINGS IN THE SOFTWARE.
21
22			#ifndef SRC_BASE_OBJECT_INL_H_
23			#define SRC_BASE_OBJECT_INL_H_
24
25			#if defined(NODE_WANT_INTERNALS) && NODE_WANT_INTERNALS
26
27			#include "base_object.h"
28			#include "env-inl.h"
29			#include "util.h"
30
31			#include "v8.h"
32
33			namespace node {
34
35			// static
36		55168	v8::Local<v8::FunctionTemplate> BaseObject::GetConstructorTemplate(
37			Environment* env) {
38		55168	return BaseObject::GetConstructorTemplate(env->isolate_data());
39			}
40
41		180592	void BaseObject::Detach() {
42	✗✓	180592	CHECK_GT(pointer_data()->strong_ptr_count, 0);
43		180592	pointer_data()->is_detached = true;
44		180592	}
45
46		465678	v8::Global<v8::Object>& BaseObject::persistent() {
47		465678	return persistent_handle_;
48			}
49
50
51		2499464	v8::Local<v8::Object> BaseObject::object() const {
52		2499464	return PersistentToLocal::Default(env()->isolate(), persistent_handle_);
53			}
54
55		138715	v8::Local<v8::Object> BaseObject::object(v8::Isolate* isolate) const {
56		138715	v8::Local<v8::Object> handle = object();
57
58			DCHECK_EQ(handle->GetCreationContext().ToLocalChecked()->GetIsolate(),
59			isolate);
60			DCHECK_EQ(env()->isolate(), isolate);
61
62		138715	return handle;
63			}
64
65		17078729	Environment* BaseObject::env() const {
66		17078729	return env_;
67			}
68
69		9920467	BaseObject* BaseObject::FromJSObject(v8::Local<v8::Value> value) {
70		9920467	v8::Local<v8::Object> obj = value.As<v8::Object>();
71			DCHECK_GE(obj->InternalFieldCount(), BaseObject::kSlot);
72			return static_cast<BaseObject*>(
73		19840934	obj->GetAlignedPointerFromInternalField(BaseObject::kSlot));
74			}
75
76
77			template <typename T>
78		775680	T* BaseObject::FromJSObject(v8::Local<v8::Value> object) {
79		775680	return static_cast<T*>(FromJSObject(object));
80			}
81
82		1253182	void BaseObject::OnGCCollect() {
83	✓✗	1253182	delete this;
84		1253182	}
85
86		2987	void BaseObject::ClearWeak() {
87	✗✓	2987	if (has_pointer_data())
88			pointer_data()->wants_weak_jsobj = false;
89
90		2987	persistent_handle_.ClearWeak();
91		2987	}
92
93			bool BaseObject::IsWeakOrDetached() const {
94			if (persistent_handle_.IsWeak()) return true;
95
96			if (!has_pointer_data()) return false;
97			const PointerData* pd = const_cast<BaseObject*>(this)->pointer_data();
98			return pd->wants_weak_jsobj \|\| pd->is_detached;
99			}
100
101			template <int Field>
102		8	void BaseObject::InternalFieldGet(
103			v8::Local<v8::String> property,
104			const v8::PropertyCallbackInfo<v8::Value>& info) {
105		8	info.GetReturnValue().Set(info.This()->GetInternalField(Field));
106		8	}
107
108			template <int Field, bool (v8::Value::* typecheck)() const>
109		99630	void BaseObject::InternalFieldSet(v8::Local<v8::String> property,
110			v8::Local<v8::Value> value,
111			const v8::PropertyCallbackInfo<void>& info) {
112			// This could be e.g. value->IsFunction().
113	✗✓	99630	CHECK(((value)->typecheck)());
114		99630	info.This()->SetInternalField(Field, value);
115		99630	}
116
117		10485086	bool BaseObject::has_pointer_data() const {
118		10485086	return pointer_data_ != nullptr;
119			}
120
121			template <typename T, bool kIsWeak>
122			BaseObject::PointerData*
123		3749659	BaseObjectPtrImpl<T, kIsWeak>::pointer_data() const {
124			if constexpr (kIsWeak) {
125		2309548	return data_.pointer_data;
126			}
127	✗✓	1440111	if (get_base_object() == nullptr) {
128			return nullptr;
129			}
130		1440111	return get_base_object()->pointer_data();
131			}
132
133			template <typename T, bool kIsWeak>
134		17198046	BaseObject* BaseObjectPtrImpl<T, kIsWeak>::get_base_object() const {
135			if constexpr (kIsWeak) {
136	✓✓	1042370	if (pointer_data() == nullptr) {
137		8	return nullptr;
138			}
139		1042362	return pointer_data()->self;
140			}
141		16155676	return data_.target;
142			}
143
144			template <typename T, bool kIsWeak>
145		3442038	BaseObjectPtrImpl<T, kIsWeak>::~BaseObjectPtrImpl() {
146			if constexpr (kIsWeak) {
147		50216	if (pointer_data() != nullptr &&
148	✓✓✓✓ ✓✓	74136	--pointer_data()->weak_ptr_count == 0 &&
149	✓✓	23920	pointer_data()->self == nullptr) {
150		30	delete pointer_data();
151			}
152	✓✓	3391822	} else if (get() != nullptr) {
153		1293503	get()->decrease_refcount();
154			}
155		3442038	}
156
157			template <typename T, bool kIsWeak>
158		2828120	BaseObjectPtrImpl<T, kIsWeak>::BaseObjectPtrImpl() {
159		2828120	data_.target = nullptr;
160		2828120	}
161
162			template <typename T, bool kIsWeak>
163		2162214	BaseObjectPtrImpl<T, kIsWeak>::BaseObjectPtrImpl(T* target)
164		2162214	: BaseObjectPtrImpl() {
165	✓✓	2162214	if (target == nullptr) return;
166			if constexpr (kIsWeak) {
167		50222	data_.pointer_data = target->pointer_data();
168	✗✓	50222	CHECK_NOT_NULL(pointer_data());
169		50222	pointer_data()->weak_ptr_count++;
170			} else {
171		1440111	data_.target = target;
172	✗✓	1440111	CHECK_NOT_NULL(pointer_data());
173		1440111	get()->increase_refcount();
174			}
175			}
176
177			template <typename T, bool kIsWeak>
178			template <typename U, bool kW>
179		43204	BaseObjectPtrImpl<T, kIsWeak>::BaseObjectPtrImpl(
180			const BaseObjectPtrImpl<U, kW>& other)
181		43204	: BaseObjectPtrImpl(other.get()) {}
182
183			template <typename T, bool kIsWeak>
184		860539	BaseObjectPtrImpl<T, kIsWeak>::BaseObjectPtrImpl(const BaseObjectPtrImpl& other)
185		860539	: BaseObjectPtrImpl(other.get()) {}
186
187			template <typename T, bool kIsWeak>
188			template <typename U, bool kW>
189		8	BaseObjectPtrImpl<T, kIsWeak>& BaseObjectPtrImpl<T, kIsWeak>::operator=(
190			const BaseObjectPtrImpl<U, kW>& other) {
191	✗✓	8	if (other.get() == get()) return *this;
192		8	this->~BaseObjectPtrImpl();
193		8	return *new (this) BaseObjectPtrImpl(other);
194			}
195
196			template <typename T, bool kIsWeak>
197		2	BaseObjectPtrImpl<T, kIsWeak>& BaseObjectPtrImpl<T, kIsWeak>::operator=(
198			const BaseObjectPtrImpl& other) {
199	✗✓	2	if (other.get() == get()) return *this;
200		2	this->~BaseObjectPtrImpl();
201		2	return *new (this) BaseObjectPtrImpl(other);
202			}
203
204			template <typename T, bool kIsWeak>
205		886973	BaseObjectPtrImpl<T, kIsWeak>::BaseObjectPtrImpl(BaseObjectPtrImpl&& other)
206		886973	: data_(other.data_) {
207			if constexpr (kIsWeak)
208		4	other.data_.target = nullptr;
209			else
210		886969	other.data_.pointer_data = nullptr;
211		886973	}
212
213			template <typename T, bool kIsWeak>
214		427824	BaseObjectPtrImpl<T, kIsWeak>& BaseObjectPtrImpl<T, kIsWeak>::operator=(
215			BaseObjectPtrImpl&& other) {
216	✗✓	427824	if (&other == this) return *this;
217		427824	this->~BaseObjectPtrImpl();
218		427824	return *new (this) BaseObjectPtrImpl(std::move(other));
219			}
220
221			template <typename T, bool kIsWeak>
222		261241	void BaseObjectPtrImpl<T, kIsWeak>::reset(T* ptr) {
223		261241	*this = BaseObjectPtrImpl(ptr);
224		261241	}
225
226			template <typename T, bool kIsWeak>
227		14504460	T* BaseObjectPtrImpl<T, kIsWeak>::get() const {
228		14504460	return static_cast<T*>(get_base_object());
229			}
230
231			template <typename T, bool kIsWeak>
232			T& BaseObjectPtrImpl<T, kIsWeak>::operator*() const {
233			return *get();
234			}
235
236			template <typename T, bool kIsWeak>
237		4139962	T* BaseObjectPtrImpl<T, kIsWeak>::operator->() const {
238		4139962	return get();
239			}
240
241			template <typename T, bool kIsWeak>
242		1239795	BaseObjectPtrImpl<T, kIsWeak>::operator bool() const {
243		1239795	return get() != nullptr;
244			}
245
246			template <typename T, bool kIsWeak>
247			template <typename U, bool kW>
248		11143	bool BaseObjectPtrImpl<T, kIsWeak>::operator ==(
249			const BaseObjectPtrImpl<U, kW>& other) const {
250		11143	return get() == other.get();
251			}
252
253			template <typename T, bool kIsWeak>
254			template <typename U, bool kW>
255			bool BaseObjectPtrImpl<T, kIsWeak>::operator !=(
256			const BaseObjectPtrImpl<U, kW>& other) const {
257			return get() != other.get();
258			}
259
260			template <typename T, typename... Args>
261		40856	BaseObjectPtr<T> MakeBaseObject(Args&&... args) {
262		40856	return BaseObjectPtr<T>(new T(std::forward<Args>(args)...));
263			}
264
265			template <typename T, typename... Args>
266		26994	BaseObjectPtr<T> MakeDetachedBaseObject(Args&&... args) {
267		26994	BaseObjectPtr<T> target = MakeBaseObject<T>(std::forward<Args>(args)...);
268		26994	target->Detach();
269		26994	return target;
270			}
271
272			} // namespace node
273
274			#endif // defined(NODE_WANT_INTERNALS) && NODE_WANT_INTERNALS
275
276			#endif // SRC_BASE_OBJECT_INL_H_