make_shared_ptr-fwd.hh

Go to the documentation of this file.
00001 /* vim: set sw=4 sts=4 et foldmethod=syntax : */
00002 
00003 /*
00004  * Copyright (c) 2007, 2008 Ciaran McCreesh
00005  *
00006  * This file is part of the Paludis package manager. Paludis is free software;
00007  * you can redistribute it and/or modify it under the terms of the GNU General
00008  * Public License version 2, as published by the Free Software Foundation.
00009  *
00010  * Paludis is distributed in the hope that it will be useful, but WITHOUT ANY
00011  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
00012  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
00013  * details.
00014  *
00015  * You should have received a copy of the GNU General Public License along with
00016  * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
00017  * Place, Suite 330, Boston, MA  02111-1307  USA
00018  */
00019 
00020 #ifndef PALUDIS_GUARD_PALUDIS_UTIL_MAKE_SHARED_PTR_FWD_HH
00021 #define PALUDIS_GUARD_PALUDIS_UTIL_MAKE_SHARED_PTR_FWD_HH 1
00022 
00023 #include <paludis/util/attributes.hh>
00024 #include <tr1/memory>
00025 
00026 /** \file
00027  * Forward declarations for paludis/make_shared_ptr.hh .
00028  *
00029  * \ingroup g_utils
00030  */
00031 
00032 namespace paludis
00033 {
00034     /**
00035      * Convenience function for creating a std::tr1::shared_ptr<> from a newly
00036      * constructed object.
00037      *
00038      * Use this only with <code>new T_(whatever)</code> as the parameter. Do not
00039      * use it to try to create a std::tr1::shared_ptr<> from something that is not
00040      * newly allocated.
00041      *
00042      * \ingroup g_utils
00043      */
00044     template <typename T_>
00045     std::tr1::shared_ptr<T_>
00046     make_shared_ptr(T_ * const t) PALUDIS_ATTRIBUTE((warn_unused_result));
00047 
00048     struct NullSharedPtr;
00049 
00050     /**
00051      * Return an object that can convert itself to an empty
00052      * std::tr1::shared_ptr<> of any type.
00053      *
00054      * \ingroup g_utils
00055      * \since 0.32
00056      */
00057     inline NullSharedPtr make_null_shared_ptr() PALUDIS_ATTRIBUTE((warn_unused_result)) PALUDIS_VISIBLE;
00058 }
00059 
00060 #endif

Generated on Mon Sep 21 10:36:08 2009 for paludis by  doxygen 1.5.4