diff options
Diffstat (limited to 'shared/loki/Pimpl.h')
| -rw-r--r-- | shared/loki/Pimpl.h | 288 |
1 files changed, 144 insertions, 144 deletions
diff --git a/shared/loki/Pimpl.h b/shared/loki/Pimpl.h index ed0d1c7b..788f76d8 100644 --- a/shared/loki/Pimpl.h +++ b/shared/loki/Pimpl.h @@ -1,12 +1,12 @@ //////////////////////////////////////////////////////////////////////////////// // The Loki Library // Copyright (c) 2006 Peter Kümmel -// Permission to use, copy, modify, distribute and sell this software for any -// purpose is hereby granted without fee, provided that the above copyright -// notice appear in all copies and that both that copyright notice and this +// Permission to use, copy, modify, distribute and sell this software for any +// purpose is hereby granted without fee, provided that the above copyright +// notice appear in all copies and that both that copyright notice and this // permission notice appear in supporting documentation. -// The author makes no representations about the -// suitability of this software for any purpose. It is provided "as is" +// The author makes no representations about the +// suitability of this software for any purpose. It is provided "as is" // without express or implied warranty. //////////////////////////////////////////////////////////////////////////////// #ifndef LOKI_PIMPL_INC_ @@ -15,7 +15,7 @@ // $Id: Pimpl.h 751 2006-10-17 19:50:37Z syntheticpp $ -/// \defgroup PimplGroup Pimpl +/// \defgroup PimplGroup Pimpl #ifndef LOKI_INHERITED_PIMPL_NAME #define LOKI_INHERITED_PIMPL_NAME d @@ -28,170 +28,170 @@ namespace Loki { - ////////////////////////////////////////// - /// \class ConstPropPtr - /// - /// \ingroup PimplGroup - /// Simple const propagating smart pointer - /// Is the default smart pointer of Pimpl. - ////////////////////////////////////////// +////////////////////////////////////////// +/// \class ConstPropPtr +/// +/// \ingroup PimplGroup +/// Simple const propagating smart pointer +/// Is the default smart pointer of Pimpl. +////////////////////////////////////////// - template<class T> - struct ConstPropPtr +template<class T> +struct ConstPropPtr +{ + explicit ConstPropPtr(T* p) : ptr_(p) {} + ~ConstPropPtr() { delete ptr_; ptr_ = 0; } + T* operator->() { return ptr_; } + T& operator*() { return *ptr_; } + const T* operator->() const { return ptr_; } + const T& operator*() const { return *ptr_; } + +private: + ConstPropPtr(); + ConstPropPtr(const ConstPropPtr&); + ConstPropPtr& operator=(const ConstPropPtr&); + T* ptr_; +}; + + +//////////////////////////////////////////////////////////////////////////////// +/// \class Pimpl +/// +/// \ingroup PimplGroup +/// +/// Implements the Pimpl idiom. It's a wrapper for a smart pointer which +/// automatically creates and deletes the implementation object and adds +/// const propagation to the smart pointer. +/// +/// \par Usage +/// see test/Pimpl +//////////////////////////////////////////////////////////////////////////////// + +template +< +class T, + typename Pointer = ConstPropPtr<T> + > +class Pimpl +{ +public: + + typedef T Impl; + + Pimpl() : ptr_(new T) + {} + + ~Pimpl() { - explicit ConstPropPtr(T* p) : ptr_(p) {} - ~ConstPropPtr() { delete ptr_; ptr_ = 0; } - T* operator->() { return ptr_; } - T& operator*() { return *ptr_; } - const T* operator->() const { return ptr_; } - const T& operator*() const { return *ptr_; } - - private: - ConstPropPtr(); - ConstPropPtr(const ConstPropPtr&); - ConstPropPtr& operator=(const ConstPropPtr&); - T* ptr_; - }; + // Don't compile with incomplete type + // + // If compilation breaks here make sure + // the compiler does not auto-generate the + // destructor of the class hosting the pimpl: + // - implement the destructor of the class + // - don't inline the destructor + typedef char T_must_be_defined[sizeof(T) ? 1 : -1 ]; + } + + + T* operator->() + { + return ptr_.operator->(); + } + T& operator*() + { + return ptr_.operator*(); + } - //////////////////////////////////////////////////////////////////////////////// - /// \class Pimpl - /// - /// \ingroup PimplGroup - /// - /// Implements the Pimpl idiom. It's a wrapper for a smart pointer which - /// automatically creates and deletes the implementation object and adds - /// const propagation to the smart pointer. - /// - /// \par Usage - /// see test/Pimpl - //////////////////////////////////////////////////////////////////////////////// - - template - < - class T, - typename Pointer = ConstPropPtr<T> - > - class Pimpl + const T* operator->() const { - public: + return ptr_.operator->(); + } - typedef T Impl; + const T& operator*() const + { + return ptr_.operator*(); + } - Pimpl() : ptr_(new T) - {} + Pointer& wrapped() + { + return ptr_; + } - ~Pimpl() - { - // Don't compile with incomplete type - // - // If compilation breaks here make sure - // the compiler does not auto-generate the - // destructor of the class hosting the pimpl: - // - implement the destructor of the class - // - don't inline the destructor - typedef char T_must_be_defined[sizeof(T) ? 1 : -1 ]; - } - - - T* operator->() - { - return ptr_.operator->(); - } - - T& operator*() - { - return ptr_.operator*(); - } - - const T* operator->() const - { - return ptr_.operator->(); - } - - const T& operator*() const - { - return ptr_.operator*(); - } - - Pointer& wrapped() - { - return ptr_; - } - - const Pointer& wrapped() const - { - return ptr_; - } - - - private: - Pimpl(const Pimpl&); - Pimpl& operator=(const Pimpl&); - - Pointer ptr_; - }; + const Pointer& wrapped() const + { + return ptr_; + } - template<class T, typename Pointer = ConstPropPtr<T> > - struct PimplOwner - { - Pimpl<T,Pointer> LOKI_INHERITED_PIMPL_NAME; - }; +private: + Pimpl(const Pimpl&); + Pimpl& operator=(const Pimpl&); + Pointer ptr_; +}; - ////////////////////////////////////////// - /// \class ImplOf - /// - /// \ingroup PimplGroup - /// Convenience template for the - /// implementations which Pimpl points to. - ////////////////////////////////////////// - template<class T> - struct ImplOf; +template<class T, typename Pointer = ConstPropPtr<T> > +struct PimplOwner +{ + Pimpl<T,Pointer> LOKI_INHERITED_PIMPL_NAME; +}; - ////////////////////////////////////////// - /// \class PImplOf - /// - /// \ingroup PimplGroup - /// Convenience template which uses ImplOf - /// as implementation structure - ////////////////////////////////////////// +////////////////////////////////////////// +/// \class ImplOf +/// +/// \ingroup PimplGroup +/// Convenience template for the +/// implementations which Pimpl points to. +////////////////////////////////////////// +template<class T> +struct ImplOf; - template<class T, template<class> class Ptr = ConstPropPtr> - struct PimplOf - { - typedef T Impl; - // declare pimpl - typedef Pimpl<ImplOf<T>, Ptr<ImplOf<T> > > Type; +////////////////////////////////////////// +/// \class PImplOf +/// +/// \ingroup PimplGroup +/// Convenience template which uses ImplOf +/// as implementation structure +////////////////////////////////////////// - // inherit pimpl - typedef PimplOwner<ImplOf<T>, Ptr<ImplOf<T> > > Owner; - }; +template<class T, template<class> class Ptr = ConstPropPtr> +struct PimplOf +{ + typedef T Impl; - template<class T, class UsedPimpl = typename PimplOf<T>::Type > - struct RimplOf - { - typedef typename UsedPimpl::Impl & Type; + // declare pimpl + typedef Pimpl<ImplOf<T>, Ptr<ImplOf<T> > > Type; - class Owner - { - UsedPimpl pimpl; + // inherit pimpl + typedef PimplOwner<ImplOf<T>, Ptr<ImplOf<T> > > Owner; +}; - public: - Owner() : LOKI_INHERITED_RIMPL_NAME(*pimpl) - {} - Type LOKI_INHERITED_RIMPL_NAME; - }; +template<class T, class UsedPimpl = typename PimplOf<T>::Type > +struct RimplOf +{ + typedef typename UsedPimpl::Impl& Type; + + class Owner + { + UsedPimpl pimpl; + + public: + Owner() : LOKI_INHERITED_RIMPL_NAME(*pimpl) + {} + Type LOKI_INHERITED_RIMPL_NAME; }; - + +}; + } #endif // end file guardian |