Utils: Add pimpl_tr (no documentation as of yet)
g0dil [Wed, 4 Aug 2010 14:53:30 +0000 (14:53 +0000)]
git-svn-id: https://svn.berlios.de/svnroot/repos/senf/trunk@1659 270642c3-0616-0410-b53a-bc976706d245

senf/Utils/pimpl_ptr.cti [new file with mode: 0644]
senf/Utils/pimpl_ptr.hh [new file with mode: 0644]
senf/Utils/pimpl_ptr.test.cc [new file with mode: 0644]

diff --git a/senf/Utils/pimpl_ptr.cti b/senf/Utils/pimpl_ptr.cti
new file mode 100644 (file)
index 0000000..4ae797a
--- /dev/null
@@ -0,0 +1,159 @@
+// $Id$
+//
+// Copyright (C) 2010
+// Fraunhofer Institute for Open Communication Systems (FOKUS)
+// Competence Center NETwork research (NET), St. Augustin, GERMANY
+//     Stefan Bund <g0dil@berlios.de>
+//
+// This program is free software; you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation; either version 2 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program; if not, write to the
+// Free Software Foundation, Inc.,
+// 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+
+/** \file
+    \brief pimpl_ptr inline template implementation */
+
+//#include "pimpl_ptr.ih"
+
+// Custom includes
+#include "IgnoreValue.hh"
+
+#define prefix_ inline
+///////////////////////////////cti.p///////////////////////////////////////
+
+///////////////////////////////////////////////////////////////////////////
+// senf::pimpl_ptr<T,CloneAllocator>
+
+template <typename T, class CloneAllocator>
+prefix_ senf::pimpl_ptr<T,CloneAllocator>::pimpl_ptr(T* pointee)
+    : p (pointee)
+{
+    // Is it fair to assume pointer assignment to be atomic on multi-threaded platforms ?
+    doCopy_ = &myCopyFn;
+    doDelete_ = &myDeleteFn;
+}
+
+template <typename T, class CloneAllocator>
+prefix_ senf::pimpl_ptr<T,CloneAllocator>::pimpl_ptr(const pimpl_ptr & rhs)
+    : p (doCopy_(rhs.p))
+{}
+
+template <typename T, class CloneAllocator>
+prefix_ senf::pimpl_ptr<T,CloneAllocator>::~pimpl_ptr()
+    throw()
+{
+    doDelete_(p);
+}
+
+template <typename T, class CloneAllocator>
+prefix_ const T* senf::pimpl_ptr<T,CloneAllocator>::get()
+    const throw()
+{
+    return p;
+}
+
+template <typename T, class CloneAllocator>
+prefix_ T* senf::pimpl_ptr<T,CloneAllocator>::get()
+    throw()
+{
+    return p;
+}
+
+template <typename T, class CloneAllocator>
+prefix_ const T* senf::pimpl_ptr<T,CloneAllocator>::operator->()
+    const throw()
+{
+    return p;
+}
+
+template <typename T, class CloneAllocator>
+prefix_ T* senf::pimpl_ptr<T,CloneAllocator>::operator->()
+    throw()
+{
+    return p;
+}
+
+template <typename T, class CloneAllocator>
+prefix_ const T& senf::pimpl_ptr<T,CloneAllocator>::operator*()
+    const throw()
+{
+    return *p;
+}
+
+template <typename T, class CloneAllocator>
+prefix_ T& senf::pimpl_ptr<T,CloneAllocator>::operator*()
+    throw()
+{
+    return *p;
+}
+
+template <typename T, class CloneAllocator>
+prefix_ void senf::pimpl_ptr<T,CloneAllocator>::swap(pimpl_ptr & with)
+    throw()
+{
+    std::swap(p, with.p);
+}
+
+template <typename T, class CloneAllocator>
+prefix_ senf::pimpl_ptr<T,CloneAllocator> &
+senf::pimpl_ptr<T,CloneAllocator>::operator=(const pimpl_ptr & rhs)
+{
+    T* pp = doCopy_(rhs.p);
+    doDelete_(p);
+    p = pp;
+    return *this;
+}
+
+template <typename T, class CloneAllocator>
+prefix_ void senf::pimpl_ptr<T,CloneAllocator>::myDeleteFn(T* p)
+{
+    return CloneAllocator::deallocate_clone(p);
+}
+
+template <typename T, class CloneAllocator>
+prefix_ T* senf::pimpl_ptr<T,CloneAllocator>::myCopyFn(const T* p)
+{
+    return CloneAllocator::allocate_clone(*p);
+}
+
+///////////////////////////////////////////////////////////////////////////
+
+template <class T, class CloneAllocator>
+prefix_ void std::swap(senf::pimpl_ptr<T,CloneAllocator> & lhs,
+                       senf::pimpl_ptr<T,CloneAllocator> & rhs)
+    throw()
+{
+    lhs.swap(rhs);
+}
+
+template <class T, class CloneAllocator>
+typename senf::pimpl_ptr<T,CloneAllocator>::Copier
+    senf::pimpl_ptr<T,CloneAllocator>::doCopy_ (0);
+
+template <class T, class CloneAllocator>
+typename senf::pimpl_ptr<T,CloneAllocator>::Deleter
+    senf::pimpl_ptr<T,CloneAllocator>::doDelete_ (0);
+
+///////////////////////////////cti.e///////////////////////////////////////
+#undef prefix_
+
+\f
+// Local Variables:
+// mode: c++
+// fill-column: 100
+// comment-column: 40
+// c-file-style: "senf"
+// indent-tabs-mode: nil
+// ispell-local-dictionary: "american"
+// compile-command: "scons -u test"
+// End:
diff --git a/senf/Utils/pimpl_ptr.hh b/senf/Utils/pimpl_ptr.hh
new file mode 100644 (file)
index 0000000..43ef8fb
--- /dev/null
@@ -0,0 +1,96 @@
+// $Id$
+//
+// Copyright (C) 2010
+// Fraunhofer Institute for Open Communication Systems (FOKUS)
+// Competence Center NETwork research (NET), St. Augustin, GERMANY
+//     Stefan Bund <g0dil@berlios.de>
+//
+// This program is free software; you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation; either version 2 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program; if not, write to the
+// Free Software Foundation, Inc.,
+// 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+
+/** \file
+    \brief pimpl_ptr public header */
+
+#ifndef HH_SENF_senf_Utils_pimpl_ptr_
+#define HH_SENF_senf_Utils_pimpl_ptr_ 1
+
+// Custom includes
+#include <algorithm>
+#include <boost/ptr_container/clone_allocator.hpp>
+
+//#include "pimpl_ptr.mpp"
+///////////////////////////////hh.p////////////////////////////////////////
+
+namespace senf
+{
+
+    template<typename T, class CloneAllocator=boost::heap_clone_allocator>
+    class pimpl_ptr
+    {
+        typedef void (*Deleter)(T* p);
+        typedef T* (*Copier)(const T* p);
+
+    public:
+        explicit pimpl_ptr(T* pointee);
+        pimpl_ptr(const pimpl_ptr & rhs);
+        ~pimpl_ptr() throw();
+
+        const T* get() const throw();
+        T* get() throw();
+
+        const T* operator->() const throw();
+        T* operator->() throw();
+
+        const T& operator*() const throw();
+        T& operator*() throw();
+
+        void swap(pimpl_ptr& with) throw();
+
+        pimpl_ptr & operator=(const pimpl_ptr & rhs);
+
+    private:
+        static Copier doCopy_;
+        static Deleter doDelete_;
+        T* p;
+
+        static void myDeleteFn(T* p);
+        static T* myCopyFn(const T* p);
+    };
+
+}
+
+namespace std
+{
+    template<class T, class CloneAllocator>
+    void swap(senf::pimpl_ptr<T,CloneAllocator>& lhs, senf::pimpl_ptr<T,CloneAllocator>& rhs)
+        throw();
+}
+
+///////////////////////////////hh.e////////////////////////////////////////
+//#include "pimpl_ptr.cci"
+//#include "pimpl_ptr.ct"
+#include "pimpl_ptr.cti"
+#endif
+
+\f
+// Local Variables:
+// mode: c++
+// fill-column: 100
+// comment-column: 40
+// c-file-style: "senf"
+// indent-tabs-mode: nil
+// ispell-local-dictionary: "american"
+// compile-command: "scons -u test"
+// End:
diff --git a/senf/Utils/pimpl_ptr.test.cc b/senf/Utils/pimpl_ptr.test.cc
new file mode 100644 (file)
index 0000000..28acd08
--- /dev/null
@@ -0,0 +1,159 @@
+// $Id$
+//
+// Copyright (C) 2010
+// Fraunhofer Institute for Open Communication Systems (FOKUS)
+// Competence Center NETwork research (NET), St. Augustin, GERMANY
+//     Stefan Bund <g0dil@berlios.de>
+//
+// This program is free software; you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation; either version 2 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program; if not, write to the
+// Free Software Foundation, Inc.,
+// 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+
+/** \file
+    \brief pimpl_ptr.test unit tests */
+
+//#include "pimpl_ptr.test.hh"
+//#include "pimpl_ptr.test.ih"
+
+// Custom includes
+#include "pimpl_ptr.hh"
+
+#include <senf/Utils/auto_unit_test.hh>
+#include <boost/test/test_tools.hpp>
+
+#define prefix_
+///////////////////////////////cc.p////////////////////////////////////////
+
+namespace {
+
+    struct PimplTest
+    {
+        struct Impl;
+        senf::pimpl_ptr<Impl> impl_;
+
+        explicit PimplTest(int v);
+    };
+
+    unsigned implConstruct (0);
+    unsigned implClone (0);
+    unsigned implDestroy (0);
+
+    struct PimplTest::Impl
+    {
+        Impl(int v) : value (v) { ++ implConstruct; }
+        Impl(Impl const & other) : value (other.value) { ++ implClone; }
+        ~Impl() { ++ implDestroy; }
+
+        int value;
+    };
+
+    prefix_ PimplTest::PimplTest(int v)
+        : impl_ (new Impl(v))
+    {}
+
+}
+
+BOOST_AUTO_UNIT_TEST(pimpl_ptr)
+{
+    {
+        PimplTest ob1 (1);
+        PimplTest ob2 (ob1);
+        PimplTest ob3 (3);
+
+        BOOST_CHECK_EQUAL( implConstruct, 2u );
+        BOOST_CHECK_EQUAL( implClone, 1u );
+        BOOST_CHECK_EQUAL( implDestroy, 0u );
+
+        BOOST_CHECK( ob1.impl_.get() != ob2.impl_.get() );
+        BOOST_CHECK( ob2.impl_.get() != ob3.impl_.get() );
+        BOOST_CHECK( ob3.impl_.get() != ob1.impl_.get() );
+
+        BOOST_CHECK_EQUAL( ob1.impl_->value, 1 );
+        BOOST_CHECK_EQUAL( ob2.impl_->value, 1 );
+        BOOST_CHECK_EQUAL( ob3.impl_->value, 3 );
+
+        ob3 = ob1;
+
+        BOOST_CHECK_EQUAL( implConstruct, 2u );
+        BOOST_CHECK_EQUAL( implClone, 2u );
+        BOOST_CHECK_EQUAL( implDestroy, 1u );
+
+        BOOST_CHECK( ob3.impl_.get() != ob1.impl_.get() );
+
+        BOOST_CHECK_EQUAL( ob1.impl_->value, 1 );
+        BOOST_CHECK_EQUAL( ob3.impl_->value, 1 );
+
+        ob3.impl_->value = 3;
+
+        BOOST_CHECK_EQUAL( ob1.impl_->value, 1 );
+        BOOST_CHECK_EQUAL( ob3.impl_->value, 3 );
+
+        struct PimplTest::Impl * p1 (ob1.impl_.get());
+        struct PimplTest::Impl * p3 (ob3.impl_.get());
+
+        std::swap(ob3.impl_, ob1.impl_);
+
+        BOOST_CHECK_EQUAL( implConstruct, 2u );
+        BOOST_CHECK_EQUAL( implClone, 2u );
+        BOOST_CHECK_EQUAL( implDestroy, 1u );
+
+        BOOST_CHECK_EQUAL( ob1.impl_->value, 3 );
+        BOOST_CHECK_EQUAL( ob3.impl_->value, 1 );
+
+        BOOST_CHECK_EQUAL( ob1.impl_.get(), p3 );
+        BOOST_CHECK_EQUAL( ob3.impl_.get(), p1 );
+    }
+
+    BOOST_CHECK_EQUAL( implConstruct, 2u );
+    BOOST_CHECK_EQUAL( implClone, 2u );
+    BOOST_CHECK_EQUAL( implDestroy, 4u );
+}
+
+#ifdef COMPILE_CHECK
+
+namespace {
+
+    // We need this template arg to delay the constructor instantiation
+    // until within COMPILE_FAIL. Otherwise the CompileCheck builder has no
+    // way to associate the error message with the test ...
+    template <class Delay=void>
+    struct PimplTestIncomplete
+    {
+        struct Impl;
+        senf::pimpl_ptr<Impl> impl_;
+        PimplTestIncomplete() : impl_ (0) {}
+    };
+
+}
+
+COMPILE_FAIL(pimpl_ptr_incomplete)
+{
+    PimplTestIncomplete<> ob;
+}
+
+#endif
+
+///////////////////////////////cc.e////////////////////////////////////////
+#undef prefix_
+
+\f
+// Local Variables:
+// mode: c++
+// fill-column: 100
+// comment-column: 40
+// c-file-style: "senf"
+// indent-tabs-mode: nil
+// ispell-local-dictionary: "american"
+// compile-command: "scons -u test"
+// End: