Qore Programming Language  1.7.0
AbstractPrivateData.h
1 /* -*- mode: c++; indent-tabs-mode: nil -*- */
2 /*
3  AbstractPrivateData.h
4 
5  abstract class for private data in objects
6 
7  Qore Programming Language
8 
9  Copyright (C) 2003 - 2022 Qore Technologies, s.r.o.
10 
11  Permission is hereby granted, free of charge, to any person obtaining a
12  copy of this software and associated documentation files (the "Software"),
13  to deal in the Software without restriction, including without limitation
14  the rights to use, copy, modify, merge, publish, distribute, sublicense,
15  and/or sell copies of the Software, and to permit persons to whom the
16  Software is furnished to do so, subject to the following conditions:
17 
18  The above copyright notice and this permission notice shall be included in
19  all copies or substantial portions of the Software.
20 
21  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
24  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
26  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
27  DEALINGS IN THE SOFTWARE.
28 
29  Note that the Qore library is released under a choice of three open-source
30  licenses: MIT (as above), LGPL 2+, or GPL 2+; see README-LICENSE for more
31  information.
32 */
33 
34 #ifndef _QORE_ABSTRACTPRIVATEDATA_H
35 
36 #define _QORE_ABSTRACTPRIVATEDATA_H
37 
38 #include <qore/QoreReferenceCounter.h>
39 
41 
45 protected:
47  DLLLOCAL virtual ~AbstractPrivateData() {}
48 
49 public:
51  DLLLOCAL void ref() const {
52  ROreference();
53  }
54 
56 
59  DLLLOCAL virtual void deref(ExceptionSink* xsink) {
60  if (ROdereference())
61  delete this;
62  }
63 
65  DLLLOCAL virtual void deref() {
66  if (ROdereference())
67  delete this;
68  }
69 };
70 
71 #endif // _QORE_ABSTRACTPRIVATEDATA_H
the base class for all data to be used as private data of Qore objects
Definition: AbstractPrivateData.h:44
DLLLOCAL void ref() const
increments the reference count of the object
Definition: AbstractPrivateData.h:51
virtual DLLLOCAL void deref()
decrements the reference count of the object without the possibility of throwing a Qore-language exce...
Definition: AbstractPrivateData.h:65
virtual DLLLOCAL ~AbstractPrivateData()
as these objects are reference counted, the destructor should be called only when the reference count...
Definition: AbstractPrivateData.h:47
container for holding Qore-language exception information and also for registering a "thread_exit" ca...
Definition: ExceptionSink.h:48
provides atomic reference counting to Qore objects
Definition: QoreReferenceCounter.h:44
DLLEXPORT void ROreference() const
atomically increments the reference count
DLLEXPORT bool ROdereference() const
atomically decrements the reference count