Home > Articles > Programming > C/C++

Smart Pointers

  • Print
  • + Share This
This chapter is from the book

7.14 Putting It All Together

Not much to go! Here comes the fun part. So far we have treated each issue in isolation. It's now time to collect all the decisions into a unique SmartPtr implementation.

The strategy we'll use is policy-based class design. Each design aspect that doesn't have a unique solution migrates to a policy. The SmartPtr class template accepts each policy as a separate template parameter. SmartPtr inherits all these template parameters, allowing the corresponding policies to store state.

Let's recap the previous sections by enumerating the variation points of SmartPtr. Each variation point translates into a policy.

  • Storage policy (Section 7.3). By default, the stored type is T* (T is the first template parameter of SmartPtr), the pointer type is again T*, and the reference type is T&. The means of destroying the pointee object is the delete operator.

  • Ownership policy (Section 7.5). Popular implementations are deep copy, reference counting, reference linking, and destructive copy. Note that Ownership is not concerned with the mechanics of destruction itself; this is Storage's task. Ownership controls the moment of destruction.

  • Conversion policy (Section 7.7). Some applications need automatic conversion to the underlying raw pointer type; others do not.

  • Checking policy (Section 7.10). This policy controls whether an initializer for SmartPtr is valid and whether a SmartPtr is valid for dereferencing.

Other issues are not worth dedicating separate policies to them or have an optimal solution:

  • The address-of operator (Section 7.6) is best not overloaded.

  • Equality and inequality tests are handled with the tricks shown in Section 7.8.

  • Ordering comparisons (Section 7.9) are left unimplemented; however, Loki specializes std::less for SmartPtr objects. The user may define an operator<, and Loki helps by defining all other ordering comparisons in terms of operator<.

  • Loki defines const-correct implementations for the SmartPtr object, the pointee object, or both.

  • There is no special support for arrays, but one of the canned Storage implementations can dispose of arrays by using operator delete[].

The presentation of the design issues surrounding smart pointers made these issues easier to understand and more manageable because each issue was discussed in isolation. It would be very helpful, then, if the implementation could decompose and treat issues in isolation instead of fighting with all the complexity at once.

Divide et Impera—this old principle coined by Julius Caesar can be of help even today with smart pointers. (I'd bet money he didn't predict that.) We break the problem into small component classes, called policies. Each policy class deals with exactly one issue. SmartPtr inherits all these classes, thus inheriting all their features. It's that simple—yet incredibly flexible, as you will soon see. Each policy is also a template parameter, which means you can mix and match existing stock policy classes or build your own.

The pointed-to type comes first, followed by each of the policies. Here is the resulting declaration of SmartPtr:

template
<
  typename T,
  template <class> class OwnershipPolicy = RefCounted,
  class ConversionPolicy = DisallowConversion,
  template <class> class CheckingPolicy = AssertCheck,
  template <class> class StoragePolicy = DefaultSPStorage
>
class SmartPtr;

The order in which the policies appear in SmartPtr's declaration puts the ones that you customize most often at the top.

The following four subsections discuss the requirements of the four policies we have defined. A rule for all policies is that they must have value semantics; that is, they must define a proper copy constructor and assignment operator.

7.14.1 The Storage Policy

The Storage policy abstracts the structure of the smart pointer. It provides type definitions and stores the actual pointee_ object.

If StorageImpl is an implementation of the Storage policy and storageImpl is an object of type StorageImpl<T>, then the constructs in Table 1 apply.

Table 1 Storage Policy Constructs

Expression

Semantics

StorageImpl<T>::StoredType

The type actually stored by the implementation. Default: T*.

StorageImpl<T>::PointerType

The pointer type defined by the implementation. This is the type returned by SmartPtr's operator->. Default: T*. Can be different from StorageImpl<T>::StoredType when you're using smart pointer layering (see Sections 7.3 and 7.13.1).

StorageImpl<T>::ReferenceType

The reference type. This is the type returned by SmartPtr's operator*. Default: T&.

GetImpl(storageImpl)

Returns an object of type StorageImpl<T> ::StoredType.

GetImplRef(storageImpl)

Returns an object of type StorageImpl<T> ::StoredType&, qualified with const if storageImpl is const.

storageImpl.operator->()

Returns an object of type StorageImpl<T> ::PointerType. Used by SmartPtr's own operator->.

storageImpl.operator*()

Returns an object of type StorageImpl<T> ::ReferenceType. Used by SmartPtr's own operator*.

StorageImpl<T>::StoredType p;

p = storageImpl.Default();

Returns the default value (usually zero).

storageImpl.Destroy()

Destroys the pointee object.


Here is the default Storage policy implementation:

template <class T>
class DefaultSPStorage
{
protected:
  typedef T* StoredType;  //the type of the pointee_ object
  typedef T* PointerType;  //type returned by operator->
  typedef T& ReferenceType; //type returned by operator*
public:
  DefaultSPStorage() : pointee_(Default())
{}
  DefaultSPStorage(const StoredType& p): pointee_(p) {}
  PointerType operator->() const { return pointee_; }
  ReferenceType operator*() const { return *pointee_; }
  friend inline PointerType GetImpl(const DefaultSPStorage& sp)
  { return sp.pointee_; }
  friend inline const StoredType& GetImplRef(
   const DefaultSPStorage& sp)
  { return sp.pointee_; }
  friend inline StoredType& GetImplRef(DefaultSPStorage& sp)
  { return sp.pointee_; }
protected:
  void Destroy()
  { delete pointee_; }
  static StoredType Default()
  { return 0; }
private:
  StoredType pointee_;
};

In addition to DefaultSPStorage, Loki also defines the following:

  • ArrayStorage, which uses operator delete[] inside Release

  • LockedStorage, which uses layering to provide a smart pointer that locks data while dereferenced (see Section 7.13.1)

  • HeapStorage, which uses an explicit destructor call followed by std::free to release the data

7.14.2 The Ownership Policy

The Ownership policy must support intrusive as well as nonintrusive reference counting. Therefore, it uses explicit function calls rather than constructor/destructor techniques. The reason is that you can call member functions at any time, whereas constructors and destructors are called automatically and only at specific times.

The Ownership policy implementation takes one template parameter, which is the corresponding pointer type. SmartPtr passes StoragePolicy<T>::PointerType to Ownership- Policy. Note that OwnershipPolicy's template parameter is a pointer type, not an object type.

If OwnershipImpl is an implementation of Ownership and ownershipImpl is an object of type OwnershipImpl<P>, then the constructs in Table 2 apply.

Table 2 Ownership Policy Constructs

Expression

Semantics

P val1;

P val2 = OwnershipImplImpl.

Clone(val1);

Clones an object. It can modify the source value if OwnershipImpl uses destructive copy.

const P val1;

P val2 = ownershipImpl.

Clone(val1);

Clones an object.

P val;

bool unique = ownershipImpl.

Release(val);

Releases ownership of an object. Returns true if the last reference to the object was released.

bool dc = OwnershipImpl<P>

::destructiveCopy;

States whether OwnershipImpl uses destructive copy. If that's the case, SmartPtr uses the Colvin/Gibbons trick used in std::auto_ptr.


An implementation of Ownership that supports reference counting is shown in the following:

template <class P>
class RefCounted
{
  unsigned int* pCount_;
protected:
  RefCounted() : pCount_(new unsigned int(1)) {}
  P Clone(const P & val)
  {
   ++*pCount_;
   return val;
  }
  bool Release(const P&)
  {
   if (!--*pCount_)
   {
     delete pCount_;
     return true;
   }
   return false;
  }
  enum { destructiveCopy = false }; // see below
{;

Implementing a policy for other schemes of reference counting is very easy. Let's write an Ownership policy implementation for COM objects. COM objects have two functions: AddRef and Release. Upon the last Release call, the object destroys itself. You need only direct Clone to AddRef and Release to COM's Release:

template <class P>
class COMRefCounted
{
public:
  static P Clone(const P& val)
  {
   val->AddRef();
   return val;
  }
  static bool Release(const P& val)
  {
   val->Release();
   return false;
  }
  enum { destructiveCopy = false }; // see below
};

Loki defines the following Ownership implementations:

  • DeepCopy, described in Section 7.5.1. DeepCopy assumes that pointee class implements a member function Clone.

  • RefCounted, described in Section 7.5.3 and in this section.

  • RefCountedMT, a multithreaded version of RefCounted.

  • COMRefCounted, a variant of intrusive reference counting described in this section.

  • RefLinked, described in Section 7.5.4.

  • DestructiveCopy, described in Section 7.5.5.

  • NoCopy, which does not define Clone, thus disabling any form of copying.

7.14.3 The Conversion Policy

Conversion is a simple policy: It defines a Boolean compile-time constant that says whether or not SmartPtr allows implicit conversion to the underlying pointer type.

If ConversionImpl is an implementation of Conversion, then the construct in Table 3 applies.

Table 3 Conversion Policy Construct

Expression

Semantics

bool allowConv =

ConversionImpl<P>::allow;

If allow is true, SmartPtr allows implicit conversion to its underlying pointer type.


The underlying pointer type of SmartPtr is dictated by its Storage policy and is StorageImpl<T>::PointerType.

As you would expect, Loki defines precisely two Conversion implementations:

  • AllowConversion

  • DisallowConversion

7.14.4 The Checking Policy

As discussed in Section 7.10, there are two main places to check a SmartPtr object for consistency: during initialization and before dereference. The checks themselves might use assert, exceptions, or lazy initialization or not do anything at all.

The Checking policy operates on the StoredType of the Storage policy, not on the PointerType. (See Section 7.14.1 for the definition of Storage.)

If S is the stored type as defined by the Storage policy implementation, and if CheckingImpl is an implementation of Checking, and if checkingImpl is an object of type CheckingImpl<S>, then the constructs in Table 4 apply.

Table 4 Checking Policy Constructs

Expression

Semantics

S value;

checkingImpl.OnDefault(value);

SmartPtr calls OnDefault in the default constructor call. If CheckingImpl does not define this function, it disables the default constructor at compile time.

S value;

checkingImpl.OnInit(value);

SmartPtr calls OnInit upon a constructor call.

S value;

checkingImpl.OnDereference

(value);

SmartPtr calls OnDereference before returning from operator-> and operator*.

const S value;

checkingImpl.OnDereference

(value);

SmartPtr calls OnDereference before returning from the const versions of operator-> and operator*.


Loki defines the following implementations of Checking:

  • AssertCheck, which uses assert for checking the value before dereferencing.

  • AssertCheckStrict, which uses assert for checking the value upon initialization.

  • RejectNullStatic, which does not define OnDefault. Consequently, any use of Smart-Ptr's default constructor yields a compile-time error.

  • RejectNull, which throws an exception if you try to dereference a null pointer.

  • RejectNullStrict, which does not accept null pointers as initializers (again, by throwing an exception).

  • NoCheck, which handles errors in the grand C and C++ tradition—that is, it does no checking at all.

  • + Share This
  • 🔖 Save To Your Account

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020