MrSID Decode SDK for Raster Reference Manual 9.5.5.5244
lti_referenceCountedObject.h
Go to the documentation of this file.
1//
2// This code is property of Celartem, Inc dba Extensis.
3// Copyright (c) 1995-2023. All rights reserved.
4// Use permitted only under license from Extensis.
5//
6/* PUBLIC */
7
8#ifndef LTI_REFERENCE_COUNTED_OBJECT_H
9#define LTI_REFERENCE_COUNTED_OBJECT_H
10
11// lt_lib_mrsid_core
12#include "lti_types.h"
13
14LT_BEGIN_LIZARDTECH_NAMESPACE
15
29{
40#define LTI_REFERENCE_COUNTED_BOILERPLATE_BASE(classname) \
41 LT_DISALLOW_COPY_CONSTRUCTOR(classname); \
42 protected: \
43 classname(void); \
44 virtual ~classname(void)
45
46#define LTI_REFERENCE_COUNTED_BOILERPLATE(classname) \
47 LTI_REFERENCE_COUNTED_BOILERPLATE_BASE(classname); \
48 public: \
49 static classname *create(void)
50
52public:
53
55 virtual void retain(void) const;
56
58 virtual void release(void) const;
59
60private:
61 mutable lt_int32 m_referenceCount;
62};
63
70template<typename TYPE> inline TYPE *
71LTI_RETAIN(TYPE *object)
72{
73 if(object != nullptr)
74 object->retain();
75 return object;
76}
77
79template<typename TYPE> inline void
80LTI_RELEASE(TYPE *&object)
81{
82 if(object != nullptr)
83 object->release();
84 object = nullptr;
85}
86
87
94template<typename TYPE>
95class RC
96{
97public:
99 ~RC(void) { LTI_RELEASE(m_object); }
100
106 RC(void) : m_object(TYPE::create()) {}
107
113 RC(TYPE *object) : m_object(LTI_RETAIN(object)) {}
114 RC &operator=(TYPE *object)
115 {
116 // retain first because object may equal m_object
117 LTI_RETAIN(object);
118 LTI_RELEASE(m_object);
119 m_object = object;
120 return *this;
121 }
122
123 RC(const RC &object) : m_object(LTI_RETAIN(object.m_object)) {}
124 RC &operator=(const RC &object)
125 {
126 // retain first because object may equal m_object
127 LTI_RETAIN(object.m_object);
128 LTI_RELEASE(m_object);
129 m_object = object.m_object;
130 return *this;
131 }
132
134 TYPE *operator->(void) { return m_object; }
135 const TYPE *operator->(void) const { return m_object; }
137 TYPE &operator*(void) { return *m_object; }
138 const TYPE &operator*(void) const { return *m_object; }
139#ifndef SWIG
141 operator TYPE *&(void) { return m_object; }
142 operator const TYPE *&(void) const { return const_cast<const TYPE *&>(m_object); }
143#endif
144
145private:
146 TYPE *m_object;
147};
148
150template<typename TYPE> inline RC<TYPE> &
152{
153 if(object != nullptr)
154 object->retain();
155 return object;
156}
157
158
159
160
161LT_END_LIZARDTECH_NAMESPACE
162
163#endif // LTI_REFERENCE_COUNTED_OBJECT_H
void LTI_RELEASE(TYPE *&object)
Call release() on non-nullptr objects and nullptr out the pointer.
#define LTI_REFERENCE_COUNTED_BOILERPLATE_BASE(classname)
Macros for defining boilerplate parts of derived LTIReferenceCountedObject classes.
TYPE * LTI_RETAIN(TYPE *object)
Helper functions that test if the object is nullptr before calling retian() and release().
This file contains a number of enums, typedefs, etc, that are used throughout the MrSID SDK.
signed int lt_int32
signed 32-bit integer
Definition: lt_types.h:42
LTIReferenceCountedObject is a base class for implementing reference counting.
virtual void release(void) const
decrement the reference counter and delete the object when the counter is zero
virtual void retain(void) const
increment reference counter
RC<> is a wrapper class around LTIReferenceCountedObject that gives the wrapped object block scoping.
RC(void)
create an object on the heap
TYPE * operator->(void)
make the wrapper look like a pointer to TYPE
RC(const RC &object)
RC & operator=(TYPE *object)
RC(TYPE *object)
manage an existing object
const TYPE & operator*(void) const
const TYPE * operator->(void) const
RC & operator=(const RC &object)
TYPE & operator*(void)
make the wrapper look like a pointer to TYPE
~RC(void)
releases the object when RC<> goes out of scope

Extensis