blocxx
RefCountedPimpl.hpp
Go to the documentation of this file.
1/*******************************************************************************
2* Copyright (C) 2005, Quest Software, Inc. All rights reserved.
3* Copyright (C) 2006, Novell, Inc. All rights reserved.
4*
5* Redistribution and use in source and binary forms, with or without
6* modification, are permitted provided that the following conditions are met:
7*
8* * Redistributions of source code must retain the above copyright notice,
9* this list of conditions and the following disclaimer.
10* * Redistributions in binary form must reproduce the above copyright
11* notice, this list of conditions and the following disclaimer in the
12* documentation and/or other materials provided with the distribution.
13* * Neither the name of
14* Quest Software, Inc.,
15* nor Novell, Inc.,
16* nor the names of its contributors or employees may be used to
17* endorse or promote products derived from this software without
18* specific prior written permission.
19*
20* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
24* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30* POSSIBILITY OF SUCH DAMAGE.
31*******************************************************************************/
32
33
34#ifndef REF_COUNTED_PIMPL_HPP
35#define REF_COUNTED_PIMPL_HPP
36
38
39#include "blocxx/BLOCXX_config.h"
42
43namespace BLOCXX_NAMESPACE
44{
45
63 template <typename Impl>
65 {
66 protected:
67 // These member functions will only get instantiated where they are
68 // used -- in the implementation code for the class. Thus the full
69 // definition of Impl need not be visible in code that merely uses
70 // a class derived from RefCountedPimpl<Impl>.
71 // Unfortunately this is not the case for any classes which need
72 // to be exported from a DLL (using __declspec(dllexport)) on
73 // windows. If that is the case, then the definition does need
74 // to be visible because every member function of the exported
75 // class and it's base classes will be instantiated.
76
78 //
80 : m_impl(0)
81 {
82 }
83
85 //
87 : m_impl(p)
88 {
89 }
90
93 //
98
100 //
101 Impl * pimpl() const
102 {
103 return static_cast<Impl *>(m_impl.getPtr());
104 }
105
107 //
108 bool null() const
109 {
110 return !m_impl;
111 }
112
113 private:
114 // IntrusiveCountableBase is used instead of Impl because we want to
115 // be able to hide the full definition of Impl while still having
116 // the implicit copy ctor, copy assignment, and dtor available.
117 //
119 };
120
121}
122
123#endif
PURPOSE: Make it easy to define immutable classes or handle classes, making it inexpensive to copy th...
IntrusiveReference< IntrusiveCountableBase > m_impl
RefCountedPimpl(IntrusiveCountableBase *p)
Taken from RFC 1321.