summaryrefslogtreecommitdiff
path: root/src/FbTk/RefCount.hh
blob: adeebf08c753a7379117d5d0a013a729b00d6c06 (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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
// RefCount.hh for FbTk - Fluxbox Toolkit
// Copyright (c) 2002 Henrik Kinnunen (fluxgen at fluxbox dot org)
//
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the "Software"),
// to deal in the Software without restriction, including without limitation
// the rights to use, copy, modify, merge, publish, distribute, sublicense,
// and/or sell copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.

#ifndef FBTK_REFCOUNT_HH
#define FBTK_REFCOUNT_HH

namespace FbTk {

/// holds a pointer with reference counting, similar to std:auto_ptr
template <typename Pointer>
class RefCount {
public:
    RefCount();
    explicit RefCount(Pointer *p);
    explicit RefCount(RefCount<Pointer> &copy);
    RefCount(const RefCount<Pointer> &copy);
    ~RefCount();
    RefCount<Pointer> &operator = (const RefCount<Pointer> &copy);
    RefCount<Pointer> &operator = (Pointer *p);
    Pointer *operator * () const { return get(); } 
    Pointer *operator -> () const { return get(); }
    Pointer *get() const { return m_data; }
#ifdef NOT_USED
    /// @return number of references
    unsigned int usedBy() const { return (m_refcount != 0 ? *m_refcount : 0); }
#endif
private:
    /// increase reference count
    void incRefCount();
    /// decrease reference count
    void decRefCount();
    Pointer *m_data; ///< data holder
    mutable unsigned int *m_refcount; ///< holds reference counting
};

// implementation

template <typename Pointer>
RefCount<Pointer>::RefCount():m_data(0), m_refcount(new unsigned int(0)) {
    incRefCount(); // it really counts how many things are storing m_refcount
}

template <typename Pointer>
RefCount<Pointer>::RefCount(RefCount<Pointer> &copy):
    m_data(copy.m_data),
    m_refcount(copy.m_refcount) {
    incRefCount();
}

template <typename Pointer>
RefCount<Pointer>::RefCount(Pointer *p):m_data(p), m_refcount(new unsigned int(0)) {
    incRefCount();
}

template <typename Pointer>
RefCount<Pointer>::RefCount(const RefCount<Pointer> &copy):
    m_data(copy.m_data),
    m_refcount(copy.m_refcount) {
    incRefCount();
}

template <typename Pointer>
RefCount<Pointer>::~RefCount() {
    decRefCount();
}

template <typename Pointer>
RefCount<Pointer> &RefCount<Pointer>::operator = (const RefCount<Pointer> &copy) {
    decRefCount(); // dec current ref count
    m_refcount = copy.m_refcount; // set new ref count
    m_data = copy.m_data; // set new data pointer
    incRefCount(); // inc new ref count 
    return *this;
}

template <typename Pointer>
RefCount<Pointer> &RefCount<Pointer>::operator = (Pointer *p) {
    decRefCount();
    m_data = p; // set data pointer
    m_refcount = new unsigned int(0); // create new counter
    incRefCount();
    return *this;
}

template <typename Pointer>
void RefCount<Pointer>::decRefCount() {
    if (m_refcount == 0)
        return;
    if (*m_refcount == 0) { // already zero, then delete refcount
        delete m_refcount;
        m_refcount = 0;
        return;
    }
    (*m_refcount)--;
    if (*m_refcount == 0) { // destroy m_data and m_refcount if nobody else is using this
        if (m_data != 0)
            delete m_data;
        m_data = 0;
        delete m_refcount;
        m_refcount = 0;
    }
}

template <typename Pointer>
void RefCount<Pointer>::incRefCount() {
    if (m_refcount == 0)
        return;
    (*m_refcount)++;
}

} // end namespace FbTk

#endif // FBTK_REFCOUNT_HH