Update copyright to LGPL on all files
[dyninst.git] / common / h / refCounter.h
1 /*
2  * Copyright (c) 1996-2009 Barton P. Miller
3  * 
4  * We provide the Paradyn Parallel Performance Tools (below
5  * described as "Paradyn") on an AS IS basis, and do not warrant its
6  * validity or performance.  We reserve the right to update, modify,
7  * or discontinue this software at any time.  We shall have no
8  * obligation to supply such updates or modifications or any other
9  * form of support to you.
10  * 
11  * By your use of Paradyn, you understand and agree that we (or any
12  * other person or entity with proprietary rights in Paradyn) are
13  * under no obligation to provide either maintenance services,
14  * update services, notices of latent defects, or correction of
15  * defects for Paradyn.
16  * 
17  * This library is free software; you can redistribute it and/or
18  * modify it under the terms of the GNU Lesser General Public
19  * License as published by the Free Software Foundation; either
20  * version 2.1 of the License, or (at your option) any later version.
21  * 
22  * This library is distributed in the hope that it will be useful,
23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
25  * Lesser General Public License for more details.
26  * 
27  * You should have received a copy of the GNU Lesser General Public
28  * License along with this library; if not, write to the Free Software
29  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
30  */
31
32
33 // $Id: refCounter.h,v 1.7 2007/05/30 19:20:03 legendre Exp $
34 // refCounter.h
35 // Ariel Tamches
36
37 #ifndef _REF_COUNTER_H_
38 #define _REF_COUNTER_H_
39
40 #ifdef external_templates
41 #pragma interface
42 #endif
43
44 #include <assert.h>
45
46 template <class T>
47 class refCounter {
48  private:
49    class actualData {
50     private:
51       mutable unsigned refCount;
52       T data;
53     public:
54       actualData(const T &src) : data(src) {refCount=0;}
55      ~actualData() {}
56       void reference() const {refCount++;}
57       bool dereference() const {
58          assert(refCount > 0);
59          return (--refCount == 0);
60       }
61       T &getData() {return data;}
62       const T &getData() const {return data;}
63    };
64    actualData *theData;
65       // allocated with new, but not necessarily by us.  _Never_ NULL.
66
67  private:
68    void reference() const {
69       assert(theData);
70       theData->reference();
71    }
72    void dereference() const {
73       assert(theData);
74       if (theData->dereference())
75          delete theData;
76    }
77
78    // explicitly disallowed
79    // (Visual C++ still requires a body, however)
80    refCounter() {}
81
82  public:
83    refCounter(const T &src) {
84       // examples:
85       // T y; (y is initialized somehow...)
86       // refCounter<T> x = y; or
87       // refCounter<T> x(y);
88       theData = new actualData(src);
89       assert(theData);
90       reference();
91    }
92    refCounter(const refCounter &src) {
93       // This constructor is what this whole class revolves around.  It's fast.
94       // examples:
95       // refCounter<T> y; (y is initialized somehow...)
96       // refCounter<T> x = y; or
97       // refCounter<T> x(y);
98       src.reference(); // just bumps up a ref count --> fast
99       theData = src.theData;  // just a ptr assignment --> fast
100    }
101   ~refCounter() {
102       dereference();
103    }
104    refCounter &operator=(const refCounter &src) {
105       if (this == &src)
106          return *this; // protect against x=x
107
108       dereference();
109
110       // ...and attach to the new stuff efficiently
111       theData = src.theData; // just a ptr assignment --> fast
112       reference();           // just bumps a ref cnt  --> fast
113       return *this;
114    }
115    refCounter &operator=(const T &src) {
116       dereference();
117       theData = new actualData(src);
118       reference();
119       return *this;
120    }
121    T &getData() {
122       assert(theData);
123       return theData->getData();
124    }
125    const T &getData() const {
126       assert(theData);
127       return theData->getData();
128    }
129 };
130
131 #endif