All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
ReferenceHolder.h
/* -*- mode: c++; indent-tabs-mode: nil -*- */
/*
ReferenceHolder.h
Smart pointer like class that dereferences
obtained pointer to a QoreReferenceCounter in its destructor.
Qore Programming Language
Copyright (C) 2006 - 2013 Qore Technologies
This library 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.1 of the License, or (at your option) any later version.
This library 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 this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
#ifndef QORE_REFERENCE_HOLDER_H_
#define QORE_REFERENCE_HOLDER_H_
#include <stdlib.h>
template<typename T = class AbstractQoreNode>
class ReferenceHolder {
private:
DLLLOCAL ReferenceHolder(const ReferenceHolder&); // not implemented
DLLLOCAL ReferenceHolder& operator=(const ReferenceHolder&); // not implemented
DLLLOCAL void* operator new(size_t); // not implemented, make sure it is not new'ed
T* p;
ExceptionSink* xsink;
public:
DLLLOCAL ReferenceHolder(ExceptionSink* xsink_) : p(0), xsink(xsink_) {}
DLLLOCAL ReferenceHolder(T* p_, ExceptionSink* xsink_) : p(p_), xsink(xsink_) {}
DLLLOCAL ~ReferenceHolder() { if (p) p->deref(xsink);}
DLLLOCAL T* operator->() { return p; }
DLLLOCAL T* operator*() { return p; }
DLLLOCAL void operator=(T *nv) {
if (p)
p->deref(xsink);
p = nv;
}
DLLLOCAL T* release() {
T *rv = p;
p = 0;
return rv;
}
DLLLOCAL operator bool() const { return p != 0; }
DLLLOCAL T** getPtrPtr() { return &p; }
DLLLOCAL T*& getRef() { return p; }
};
template<typename T>
class SimpleRefHolder {
private:
DLLLOCAL SimpleRefHolder(const SimpleRefHolder&); // not implemented
DLLLOCAL SimpleRefHolder& operator=(const SimpleRefHolder&); // not implemented
DLLLOCAL void* operator new(size_t); // not implemented, make sure it is not new'ed
T* p;
public:
DLLLOCAL SimpleRefHolder() : p(0) {}
DLLLOCAL SimpleRefHolder(T* p_) : p(p_) {}
DLLLOCAL ~SimpleRefHolder() { if (p) p->deref(); }
DLLLOCAL T* operator->() { return p; }
DLLLOCAL T* operator*() { return p; }
DLLLOCAL void operator=(T *nv) {
if (p)
p->deref();
p = nv;
}
DLLLOCAL T *release() {
T *rv = p;
p = 0;
return rv;
}
DLLLOCAL operator bool() const { return p != 0; }
};
#endif
// EOF
ReferenceHolder::getPtrPtr
DLLLOCAL T ** getPtrPtr()
returns a pointer to the pointer being managed
Definition: ReferenceHolder.h:86
ReferenceHolder::ReferenceHolder
DLLLOCAL ReferenceHolder(T *p_, ExceptionSink *xsink_)
populates with object with data and the ExceptionSink pointer
Definition: ReferenceHolder.h:57
ReferenceHolder::release
DLLLOCAL T * release()
releases the pointer to the caller
Definition: ReferenceHolder.h:76
ReferenceHolder::operator*
DLLLOCAL T * operator*()
returns the pointer being managed
Definition: ReferenceHolder.h:66
ReferenceHolder::~ReferenceHolder
DLLLOCAL ~ReferenceHolder()
calls deref(ExceptionSink *) on the pointer being managed if not 0
Definition: ReferenceHolder.h:60
ReferenceHolder::getRef
DLLLOCAL T *& getRef()
returns a reference to the ptr being managed
Definition: ReferenceHolder.h:89
ExceptionSink
container for holding Qore-language exception information and also for registering a &quot;thread_exit&quot; ca...
Definition: ExceptionSink.h:35
SimpleRefHolder
manages a reference count of a pointer to a class that takes a simple &quot;deref()&quot; call with no argument...
Definition: ReferenceHolder.h:103
ReferenceHolder::operator->
DLLLOCAL T * operator->()
returns the pointer being managed
Definition: ReferenceHolder.h:63
ReferenceHolder::ReferenceHolder
DLLLOCAL ReferenceHolder(ExceptionSink *xsink_)
creates an empty ReferenceHolder
Definition: ReferenceHolder.h:54
ReferenceHolder::operator=
DLLLOCAL void operator=(T *nv)
assigns a new pointer to the holder, dereferences the current pointer if any
Definition: ReferenceHolder.h:69
ReferenceHolder
a templated class to manage a reference count of an object that can throw a Qore-language exception w...
Definition: ReferenceHolder.h:43