summaryrefslogtreecommitdiff
path: root/include/mts/MTS_AutoPtr.h
blob: 68b82cfe823a1fdc54fff8d8d636e48316245dfc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
/*
 * Copyright (C) 2015 by Multi-Tech Systems
 *
 * This file is part of libmts.
 *
 * libmts is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 2 of the License, or
 * (at your option) any later version.
 *
 * libmts 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with libmts.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

/*! \file MTS_AutoPtr.h
 \brief An autopointer
 \date 15JUN11
 \author Sean Godinez

 An autopointer.
 */

#ifndef MTS_AUTOPTR_H
#define MTS_AUTOPTR_H

#include <mts/MTS_NonCopyable.h>
#include <mts/MTS_Stdint.h>

namespace MTS {

    //! An autopointer
    /*!
     An autopointer cleans up after itself.
     */
    template<class T> class AutoPtr: NonCopyable {

        public:
            enum MallocType {
                SINGLE, ARRAY
            };

            explicit AutoPtr(T* ptr = 0, MallocType type = SINGLE); //!< Explicitly Constructs the AutoPtr to reference ptr
            ~AutoPtr();                                             //!< Destructs the AutoPtr deleting T

            T& operator*() const;                                   //!< Returns T
            T* operator->() const;                                  //!< Returns address of T
            T& operator[](const uint32_t& index) const;             //!< Returns T at index
            T* get() const;                                         //!< Returns address of T
            T* release();                                           //!< Removes reference to T (does NOT delete T) and returns address
            void reset(T* ptr = 0, MallocType type = SINGLE);       //!< Deletes old T and assigns internal reference to ptr
            bool isNull() const;			                        //!< Returns true if pointer is NULL

        private:
            T* m_pObj;                                              //!< Reference to class T
            MallocType m_eType;                                     //!< Describes memory allocated as a single T or block of Ts

    };

    template<class T> AutoPtr<T>::AutoPtr(T* ptr, MallocType type)
    : m_pObj(ptr), m_eType(type) {
    }

    template<class T> AutoPtr<T>::~AutoPtr() {
        if (m_eType == SINGLE) {
            delete m_pObj;
        } else {
            delete[] m_pObj;
        }
    }

    template<class T> T& AutoPtr<T>::operator*() const {
        return *m_pObj;
    }

    template<class T> T* AutoPtr<T>::operator->() const {
        return m_pObj;
    }

    template<class T> T& AutoPtr<T>::operator[](const uint32_t& index) const {
        return m_pObj[index];
    }

    template<class T> T* AutoPtr<T>::get() const {
        return m_pObj;
    }

    template<class T> T* AutoPtr<T>::release() {
        T* temp = m_pObj;
        m_pObj = 0;
        return temp;
    }

    template<class T> void AutoPtr<T>::reset(T* ptr, MallocType type) {
        T* temp = m_pObj;
        m_pObj = ptr;
        if (m_eType == SINGLE) {
            delete temp;
        } else {
            delete[] temp;
        }
        m_eType = type;
    }

    template<class T> bool AutoPtr<T>::isNull() const {
        return (m_pObj == 0);
    }
}

#endif