src/gromacs/utility/uniqueptr.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2013,2014,2015, by the GROMACS development team, led by
   5  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   6  * and including many others, as listed in the AUTHORS file in the
   7  * top-level source directory and at http://www.gromacs.org.
   8  *
   9  * GROMACS is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public License
  11  * as published by the Free Software Foundation; either version 2.1
  12  * of the License, or (at your option) any later version.
  13  *
  14  * GROMACS is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with GROMACS; if not, see
  21  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  23  *
  24  * If you want to redistribute modifications to GROMACS, please
  25  * consider that scientific software is very special. Version
  26  * control is crucial - bugs must be traceable. We will be happy to
  27  * consider code for inclusion in the official distribution, but
  28  * derived work must not be called official GROMACS. Details are found
  29  * in the README & COPYING files - if they are missing, get the
  30  * official version at http://www.gromacs.org.
  31  *
  32  * To help us fund GROMACS development, we humbly ask that you cite
  33  * the research papers on the package. Check out http://www.gromacs.org.
  34  */
  35 /*! \libinternal \file
  36  * \brief
  37  * Declares gmx::gmx_unique_ptr and supporting functionality.
  38  *
  39  * \author Roland Schulz <roland@utk.edu>
  40  * \author John Eblen <jeblen@acm.org>
  41  * \inlibraryapi
  42  * \ingroup module_utility
  43  */
  44 #ifndef GMX_UTILITY_UNIQUEPTR_H
  45 #define GMX_UTILITY_UNIQUEPTR_H
  46
  47 #include "config.h"
  48
  49 #if GMX_CXX11      // C++11 Compiler
  50 #include <memory>  // IWYU pragma: export
  51 #include <utility> // IWYU pragma: export
  52 #else              // C++03 Compiler
  53 #include <boost/shared_ptr.hpp>
  54 #endif
  55
  56 namespace gmx
  57 {
  58
  59 //! \cond libapi
  60 /*! \libinternal \class gmx_unique_ptr
  61  * \brief
  62  * Smart pointer for unique ownership.
  63  *
  64  * The \a type member typedef declares the actual smart pointer type.
  65  * If std::unique_ptr from C++11 is available, it is used, otherwise maps to
  66  * boost::shared_ptr. Because of this, there are some limitations to usage.
  67  * gmx::move() should be used to move the pointer.
  68  *
  69  * Avoid using directly as a type, use a typedef instead. Typical usage:
  70  * \code
  71    typedef gmx_unique_ptr<ExampleClass>::type ExampleClassPointer;
  72    \endcode
  73  *
  74  * \ingroup module_utility
  75  * \inlibraryapi
  76  */
  77 /*! \libinternal \typedef gmx_unique_ptr::type
  78  * \brief The smart pointer type.
  79  * Work-around for the non-existence of template typedefs in C++03.
  80  */
  81 #if GMX_CXX11 // C++11 Compiler
  82 using std::move;
  83 template<typename T>
  84 struct gmx_unique_ptr
  85 {
  86     typedef std::unique_ptr<T> type;
  87 };
  88 #else // C++03 Compiler
  89 /*! \fn boost::shared_ptr<T> &move(boost::shared_ptr<T> &ptr)
  90  * \brief
  91  * Moves gmx::gmx_unique_ptr type pointers
  92  *
  93  * For C++11 gmx::move is the std::move, for non-C++11 compilers, the
  94  * move operation is a no-op.
  95  *
  96  * \inlibraryapi
  97  */
  98 template<typename T>
  99 boost::shared_ptr<T> &move(boost::shared_ptr<T> &ptr)
 100 {
 101     return ptr;
 102 }
 103 template<typename T>
 104 struct gmx_unique_ptr
 105 {
 106     typedef boost::shared_ptr<T> type;
 107 };
 108 #endif
 109 //! \endcond
 110
 111 } // namespace gmx
 112
 113 #endif