From e97d714bbc38a65c60b6064a74cf1abad90834ae Mon Sep 17 00:00:00 2001 From: Andreas Kling Date: Fri, 21 Jun 2019 18:42:17 +0200 Subject: [PATCH] Documentation: Update SmartPointers.md with new pointer names. --- Documentation/SmartPointers.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/Documentation/SmartPointers.md b/Documentation/SmartPointers.md index 87cad55ea59..76e2844563b 100644 --- a/Documentation/SmartPointers.md +++ b/Documentation/SmartPointers.md @@ -25,26 +25,26 @@ There is a make() helper that creates a new object and returns it wrapped in ---- -## RetainPtr and Retained +## RefPtr and NonnullRefPtr -RetainPtr is used for multiple-owner objects. An object held by a RetainPtr is owned together by every pointer pointing to that object. +RefPtr is used for multiple-owner objects. An object held by a RefPtr is owned together by every pointer pointing to that object. -Shared ownership is implemented via retain counting (or "reference counting", as some people call it.) +Shared ownership is implemented via reference counting. -Retained is a special variant of RetainPtr with one additional property: it cannot be null. Retained is suitable as a return type from functions that are guaranteed to never return null, and as an argument type where the argument may not be null. In other words, if RetainPtr is "\*", then Retained is "&". +NonnullRefPtr is a special variant of RefPtr with one additional property: it cannot be null. NonnullRefPtr is suitable as a return type from functions that are guaranteed to never return null, and as an argument type where the argument may not be null. In other words, if RefPtr is "\*", then NonnullRefPtr is "&". -Objects can only be held by RetainPtr if they meet certain criteria. Specifically, they need to implement the functions `retain()` and `release()`. +Objects can only be held by RefPtr if they meet certain criteria. Specifically, they need to implement the functions `ref()` and `deref()`. -To make a class T retainable, you can simply make it inherit from Retainable. This will add all the necessary pieces to T. +To make a class T reference counted, you can simply make it inherit from RefCounted. This will add all the necessary pieces to T. -**Note:** When constructing a Retainable-derived class, the retain count starts out at 1 (since 0 would mean that the object has no owners and should be deleted.) The object must therefore be "adopted" by someone who takes responsibility of that 1. This is done through the global `adopt()` function: +**Note:** When constructing a RefCounted-derived class, the reference count starts out at 1 (since 0 would mean that the object has no owners and should be deleted.) The object must therefore be "adopted" by someone who takes responsibility of that 1. This is done through the global `adopt()` function: - class Bar : public Retainable { + class Bar : public RefCounted { ... }; - RetainPtr our_object = adopt(*new Bar); - RetainPtr another_owner = our_object; + RefPtr our_object = adopt(*new Bar); + RefPtr another_owner = our_object; In the above example, the Bar object will only be deleted once both "our\_object" and "another\_owner" are gone.