Head

GCC Code Coverage Report

Directory:	./		Exec	Total	Coverage
File:	base_object-inl.h	Lines:	108	114	94.7 %
Date:	2022-10-02 04:22:39	Branches:	25	42	59.5 %


// 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 {

BaseObject::BaseObject(Environment* env, v8::Local<v8::Object> object)
    : BaseObject(env->principal_realm(), object) {}

// 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 realm_->env();
}

Realm* BaseObject::realm() const {
  return realm_;
}

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		1460796	BaseObject::BaseObject(Environment* env, v8::Local<v8::Object> object)
36		1460796	: BaseObject(env->principal_realm(), object) {}
37
38			// static
39		55493	v8::Local<v8::FunctionTemplate> BaseObject::GetConstructorTemplate(
40			Environment* env) {
41		55493	return BaseObject::GetConstructorTemplate(env->isolate_data());
42			}
43
44		258950	void BaseObject::Detach() {
45	✗✓	258950	CHECK_GT(pointer_data()->strong_ptr_count, 0);
46		258950	pointer_data()->is_detached = true;
47		258950	}
48
49		390166	v8::Global<v8::Object>& BaseObject::persistent() {
50		390166	return persistent_handle_;
51			}
52
53
54		2508241	v8::Local<v8::Object> BaseObject::object() const {
55		2508241	return PersistentToLocal::Default(env()->isolate(), persistent_handle_);
56			}
57
58		137143	v8::Local<v8::Object> BaseObject::object(v8::Isolate* isolate) const {
59		137143	v8::Local<v8::Object> handle = object();
60
61			DCHECK_EQ(handle->GetCreationContext().ToLocalChecked()->GetIsolate(),
62			isolate);
63			DCHECK_EQ(env()->isolate(), isolate);
64
65		137143	return handle;
66			}
67
68		13840522	Environment* BaseObject::env() const {
69		13840522	return realm_->env();
70			}
71
72		3264723	Realm* BaseObject::realm() const {
73		3264723	return realm_;
74			}
75
76		9987003	BaseObject* BaseObject::FromJSObject(v8::Local<v8::Value> value) {
77		9987003	v8::Local<v8::Object> obj = value.As<v8::Object>();
78			DCHECK_GE(obj->InternalFieldCount(), BaseObject::kSlot);
79			return static_cast<BaseObject*>(
80		19974006	obj->GetAlignedPointerFromInternalField(BaseObject::kSlot));
81			}
82
83
84			template <typename T>
85		760703	T* BaseObject::FromJSObject(v8::Local<v8::Value> object) {
86		760703	return static_cast<T*>(FromJSObject(object));
87			}
88
89		1268580	void BaseObject::OnGCCollect() {
90	✓✗	1268580	delete this;
91		1268580	}
92
93		80899	void BaseObject::ClearWeak() {
94	✓✓	80899	if (has_pointer_data())
95		8188	pointer_data()->wants_weak_jsobj = false;
96
97		80899	persistent_handle_.ClearWeak();
98		80899	}
99
100			bool BaseObject::IsWeakOrDetached() const {
101			if (persistent_handle_.IsWeak()) return true;
102
103			if (!has_pointer_data()) return false;
104			const PointerData* pd = const_cast<BaseObject*>(this)->pointer_data();
105			return pd->wants_weak_jsobj \|\| pd->is_detached;
106			}
107
108			template <int Field>
109		8	void BaseObject::InternalFieldGet(
110			v8::Local<v8::String> property,
111			const v8::PropertyCallbackInfo<v8::Value>& info) {
112		8	info.GetReturnValue().Set(info.This()->GetInternalField(Field));
113		8	}
114
115			template <int Field, bool (v8::Value::* typecheck)() const>
116		100079	void BaseObject::InternalFieldSet(v8::Local<v8::String> property,
117			v8::Local<v8::Value> value,
118			const v8::PropertyCallbackInfo<void>& info) {
119			// This could be e.g. value->IsFunction().
120	✗✓	100079	CHECK(((value)->typecheck)());
121		100079	info.This()->SetInternalField(Field, value);
122		100079	}
123
124		11638420	bool BaseObject::has_pointer_data() const {
125		11638420	return pointer_data_ != nullptr;
126			}
127
128			template <typename T, bool kIsWeak>
129			BaseObject::PointerData*
130		3922581	BaseObjectPtrImpl<T, kIsWeak>::pointer_data() const {
131			if constexpr (kIsWeak) {
132		2313388	return data_.pointer_data;
133			}
134	✗✓	1609193	if (get_base_object() == nullptr) {
135			return nullptr;
136			}
137		1609193	return get_base_object()->pointer_data();
138			}
139
140			template <typename T, bool kIsWeak>
141		18560790	BaseObject* BaseObjectPtrImpl<T, kIsWeak>::get_base_object() const {
142			if constexpr (kIsWeak) {
143	✓✓	1043996	if (pointer_data() == nullptr) {
144		8	return nullptr;
145			}
146		1043988	return pointer_data()->self;
147			}
148		17516794	return data_.target;
149			}
150
151			template <typename T, bool kIsWeak>
152		3784787	BaseObjectPtrImpl<T, kIsWeak>::~BaseObjectPtrImpl() {
153			if constexpr (kIsWeak) {
154		50346	if (pointer_data() != nullptr &&
155	✓✓✓✓ ✓✓	74330	--pointer_data()->weak_ptr_count == 0 &&
156	✓✓	23984	pointer_data()->self == nullptr) {
157		34	delete pointer_data();
158			}
159	✓✓	3734441	} else if (get() != nullptr) {
160		1525216	get()->decrease_refcount();
161			}
162		3784787	}
163
164			template <typename T, bool kIsWeak>
165		2994208	BaseObjectPtrImpl<T, kIsWeak>::BaseObjectPtrImpl() {
166		2994208	data_.target = nullptr;
167		2994208	}
168
169			template <typename T, bool kIsWeak>
170		2329196	BaseObjectPtrImpl<T, kIsWeak>::BaseObjectPtrImpl(T* target)
171		2329196	: BaseObjectPtrImpl() {
172	✓✓	2329196	if (target == nullptr) return;
173			if constexpr (kIsWeak) {
174		50352	data_.pointer_data = target->pointer_data();
175	✗✓	50352	CHECK_NOT_NULL(pointer_data());
176		50352	pointer_data()->weak_ptr_count++;
177			} else {
178		1609193	data_.target = target;
179	✗✓	1609193	CHECK_NOT_NULL(pointer_data());
180		1609193	get()->increase_refcount();
181			}
182			}
183
184			template <typename T, bool kIsWeak>
185			template <typename U, bool kW>
186		43495	BaseObjectPtrImpl<T, kIsWeak>::BaseObjectPtrImpl(
187			const BaseObjectPtrImpl<U, kW>& other)
188		43495	: BaseObjectPtrImpl(other.get()) {}
189
190			template <typename T, bool kIsWeak>
191		857488	BaseObjectPtrImpl<T, kIsWeak>::BaseObjectPtrImpl(const BaseObjectPtrImpl& other)
192		857488	: BaseObjectPtrImpl(other.get()) {}
193
194			template <typename T, bool kIsWeak>
195			template <typename U, bool kW>
196		8	BaseObjectPtrImpl<T, kIsWeak>& BaseObjectPtrImpl<T, kIsWeak>::operator=(
197			const BaseObjectPtrImpl<U, kW>& other) {
198	✗✓	8	if (other.get() == get()) return *this;
199		8	this->~BaseObjectPtrImpl();
200		8	return *new (this) BaseObjectPtrImpl(other);
201			}
202
203			template <typename T, bool kIsWeak>
204		2	BaseObjectPtrImpl<T, kIsWeak>& BaseObjectPtrImpl<T, kIsWeak>::operator=(
205			const BaseObjectPtrImpl& other) {
206	✗✓	2	if (other.get() == get()) return *this;
207		2	this->~BaseObjectPtrImpl();
208		2	return *new (this) BaseObjectPtrImpl(other);
209			}
210
211			template <typename T, bool kIsWeak>
212		885707	BaseObjectPtrImpl<T, kIsWeak>::BaseObjectPtrImpl(BaseObjectPtrImpl&& other)
213		885707	: data_(other.data_) {
214			if constexpr (kIsWeak)
215		4	other.data_.target = nullptr;
216			else
217		885703	other.data_.pointer_data = nullptr;
218		885707	}
219
220			template <typename T, bool kIsWeak>
221		428184	BaseObjectPtrImpl<T, kIsWeak>& BaseObjectPtrImpl<T, kIsWeak>::operator=(
222			BaseObjectPtrImpl&& other) {
223	✗✓	428184	if (&other == this) return *this;
224		428184	this->~BaseObjectPtrImpl();
225		428184	return *new (this) BaseObjectPtrImpl(std::move(other));
226			}
227
228			template <typename T, bool kIsWeak>
229		261501	void BaseObjectPtrImpl<T, kIsWeak>::reset(T* ptr) {
230		261501	*this = BaseObjectPtrImpl(ptr);
231		261501	}
232
233			template <typename T, bool kIsWeak>
234		15529512	T* BaseObjectPtrImpl<T, kIsWeak>::get() const {
235		15529512	return static_cast<T*>(get_base_object());
236			}
237
238			template <typename T, bool kIsWeak>
239			T& BaseObjectPtrImpl<T, kIsWeak>::operator*() const {
240			return *get();
241			}
242
243			template <typename T, bool kIsWeak>
244		4849817	T* BaseObjectPtrImpl<T, kIsWeak>::operator->() const {
245		4849817	return get();
246			}
247
248			template <typename T, bool kIsWeak>
249		1247664	BaseObjectPtrImpl<T, kIsWeak>::operator bool() const {
250		1247664	return get() != nullptr;
251			}
252
253			template <typename T, bool kIsWeak>
254			template <typename U, bool kW>
255		11144	bool BaseObjectPtrImpl<T, kIsWeak>::operator ==(
256			const BaseObjectPtrImpl<U, kW>& other) const {
257		11144	return get() == other.get();
258			}
259
260			template <typename T, bool kIsWeak>
261			template <typename U, bool kW>
262			bool BaseObjectPtrImpl<T, kIsWeak>::operator !=(
263			const BaseObjectPtrImpl<U, kW>& other) const {
264			return get() != other.get();
265			}
266
267			template <typename T, typename... Args>
268		41205	BaseObjectPtr<T> MakeBaseObject(Args&&... args) {
269		41205	return BaseObjectPtr<T>(new T(std::forward<Args>(args)...));
270			}
271
272			template <typename T, typename... Args>
273		27227	BaseObjectPtr<T> MakeDetachedBaseObject(Args&&... args) {
274		27227	BaseObjectPtr<T> target = MakeBaseObject<T>(std::forward<Args>(args)...);
275		27227	target->Detach();
276		27227	return target;
277			}
278
279			} // namespace node
280
281			#endif // defined(NODE_WANT_INTERNALS) && NODE_WANT_INTERNALS
282
283			#endif // SRC_BASE_OBJECT_INL_H_