Qore Programming Language - C/C++ Library  0.8.13.4
ReferenceHolder.h
1 /* -*- mode: c++; indent-tabs-mode: nil -*- */
2 /*
3  ReferenceHolder.h
4 
5  Smart pointer like class that dereferences
6  obtained pointer to a QoreReferenceCounter in its destructor.
7 
8  Qore Programming Language
9 
10  Copyright (C) 2006 - 2015 Qore Technologies
11 
12  Permission is hereby granted, free of charge, to any person obtaining a
13  copy of this software and associated documentation files (the "Software"),
14  to deal in the Software without restriction, including without limitation
15  the rights to use, copy, modify, merge, publish, distribute, sublicense,
16  and/or sell copies of the Software, and to permit persons to whom the
17  Software is furnished to do so, subject to the following conditions:
18 
19  The above copyright notice and this permission notice shall be included in
20  all copies or substantial portions of the Software.
21 
22  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
23  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
24  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
25  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
26  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
27  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
28  DEALINGS IN THE SOFTWARE.
29 
30  Note that the Qore library is released under a choice of three open-source
31  licenses: MIT (as above), LGPL 2+, or GPL 2+; see README-LICENSE for more
32  information.
33 */
34 
35 #ifndef QORE_REFERENCE_HOLDER_H_
36 #define QORE_REFERENCE_HOLDER_H_
37 
38 #include <stdlib.h>
39 
41 
50 template<typename T = class AbstractQoreNode>
52 private:
53  DLLLOCAL ReferenceHolder(const ReferenceHolder&); // not implemented
54  DLLLOCAL ReferenceHolder& operator=(const ReferenceHolder&); // not implemented
55  DLLLOCAL void* operator new(size_t); // not implemented, make sure it is not new'ed
56 
57  T* p;
58  ExceptionSink* xsink;
59 
60 public:
62  DLLLOCAL ReferenceHolder(ExceptionSink* xsink_) : p(0), xsink(xsink_) {}
63 
65  DLLLOCAL ReferenceHolder(T* p_, ExceptionSink* xsink_) : p(p_), xsink(xsink_) {}
66 
68  DLLLOCAL ~ReferenceHolder() { if (p) p->deref(xsink);}
69 
71  DLLLOCAL T* operator->() { return p; }
72 
74  DLLLOCAL T* operator*() { return p; }
75 
77  DLLLOCAL const T* operator->() const { return p; }
78 
80  DLLLOCAL const T* operator*() const { return p; }
81 
83  DLLLOCAL void operator=(T *nv) {
84  if (p)
85  p->deref(xsink);
86  p = nv;
87  }
88 
90  DLLLOCAL T* release() {
91  T *rv = p;
92  p = 0;
93  return rv;
94  }
95 
97  DLLLOCAL operator bool() const { return p != 0; }
98 
100  DLLLOCAL T** getPtrPtr() { return &p; }
101 
103  DLLLOCAL T*& getRef() { return p; }
104 };
105 
107 
116 template<typename T>
118 private:
119  DLLLOCAL SimpleRefHolder(const SimpleRefHolder&); // not implemented
120  DLLLOCAL SimpleRefHolder& operator=(const SimpleRefHolder&); // not implemented
121  DLLLOCAL void* operator new(size_t); // not implemented, make sure it is not new'ed
122 
123  T* p;
124 
125 public:
126  DLLLOCAL SimpleRefHolder() : p(0) {}
127  DLLLOCAL SimpleRefHolder(T* p_) : p(p_) {}
128  DLLLOCAL ~SimpleRefHolder() { if (p) p->deref(); }
129 
130  DLLLOCAL T* operator->() { return p; }
131  DLLLOCAL T* operator*() { return p; }
132  DLLLOCAL const T* operator->() const { return p; }
133  DLLLOCAL const T* operator*() const { return p; }
134  DLLLOCAL void operator=(T *nv) {
135  if (p)
136  p->deref();
137  p = nv;
138  }
139  DLLLOCAL T *release() {
140  T *rv = p;
141  p = 0;
142  return rv;
143  }
144  DLLLOCAL operator bool() const { return p != 0; }
145 };
146 
147 #endif
148 // EOF
DLLLOCAL T ** getPtrPtr()
returns a pointer to the pointer being managed
Definition: ReferenceHolder.h:100
DLLLOCAL T * release()
releases the pointer to the caller
Definition: ReferenceHolder.h:90
DLLLOCAL T * operator*()
returns the pointer being managed
Definition: ReferenceHolder.h:74
DLLLOCAL ~ReferenceHolder()
calls deref(ExceptionSink *) on the pointer being managed if not 0
Definition: ReferenceHolder.h:68
DLLLOCAL T *& getRef()
returns a reference to the ptr being managed
Definition: ReferenceHolder.h:103
container for holding Qore-language exception information and also for registering a "thread_exit" ca...
Definition: ExceptionSink.h:47
manages a reference count of a pointer to a class that takes a simple "deref()" call with no argument...
Definition: ReferenceHolder.h:117
DLLLOCAL T * operator->()
returns the pointer being managed
Definition: ReferenceHolder.h:71
a templated class to manage a reference count of an object that can throw a Qore-language exception w...
Definition: ReferenceHolder.h:51