Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/output/src/libraries/util/DestructionHelper.h @ 8779

Last change on this file since 8779 was 8423, checked in by rgrieder, 14 years ago

Added and incorporated new class DestructionHelper: instead of doing the destruction of certain singletons implicitly via scoped_ptrs and ScopeGuards, use a method named destroy() that essentially achieves the same, but makes the destruction sequence obvious.

  • Property svn:eol-style set to native
File size: 2.4 KB
Line 
1/*
2 *   ORXONOX - the hottest 3D action shooter ever to exist
3 *                    > www.orxonox.net <
4 *
5 *
6 *   License notice:
7 *
8 *   This program is free software; you can redistribute it and/or
9 *   modify it under the terms of the GNU General Public License
10 *   as published by the Free Software Foundation; either version 2
11 *   of the License, or (at your option) any later version.
12 *
13 *   This program is distributed in the hope that it will be useful,
14 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
15 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 *   GNU General Public License for more details.
17 *
18 *   You should have received a copy of the GNU General Public License
19 *   along with this program; if not, write to the Free Software
20 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
21 *
22 *   Author:
23 *      Reto Grieder
24 *   Co-authors:
25 *      ...
26 *
27 */
28
29#ifndef __DestructionHelper_H__
30#define __DestructionHelper_H__
31
32#include "UtilPrereqs.h"
33
34namespace orxonox
35{
36    /** Deletes an object and resets the pointer
37    @param object
38        Pointer to an object. Handing over NULL is safe.
39    */
40    template <class T>
41    void safeObjectDelete(T** object)
42    {
43        delete *object;
44        *object = NULL;
45    }
46
47    /** Utility class that helps to create a special kind of destructor that
48        also executes if the destruction fails.
49        This helps a lot to improve exception handling. <br>
50        <br>
51        Example: <br>
52        @code
53        class MyClass
54        {
55        public:
56            MyClass() : destructionHelper_(this)
57            {
58                // Do something that might throw
59            }
60            ~MyClass()
61            {
62                // Keep empty!
63            }
64            void destroy()
65            {
66                // Place your destruction code here instead
67            }
68
69        private:
70            orxonox::DestructionHelper<MyClass> destructionHelper_;
71        };
72        @endcode
73    */
74    template <class T>
75    class DestructionHelper
76    {
77    public:
78        DestructionHelper(T* object)
79            : object_(object)
80        {
81        }
82
83        ~DestructionHelper()
84        {
85            object_->destroy();
86        }
87
88    private:
89        DestructionHelper(const DestructionHelper&); //!< Don't use (undefined)
90
91        T* object_;
92    };
93}
94
95#endif /* __DestructionHelper_H__ */
Note: See TracBrowser for help on using the repository browser.